Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update links to juju.is/docs #2090

Open
medubelko opened this issue Jan 17, 2025 · 2 comments
Open

Docs: Update links to juju.is/docs #2090

medubelko opened this issue Jan 17, 2025 · 2 comments
Labels

Comments

@medubelko
Copy link
Contributor

What needs to get done

The main Juju docs are being migrated to https://canonical-juju.readthedocs-hosted.com/en/latest. The Juju site will redirect to them itself, but it's best not to link to a redirect.

The Juju RTD docs are live as of this week, so we should be able to change all the links to them right away.

Why it needs to get done

The docs on the Discourse instance are being retired.

Copy link

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3953.

This message was autogenerated

Copy link

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3954.

This message was autogenerated

lengau added a commit that referenced this issue Jan 18, 2025
This is a partial for #2090
lengau added a commit that referenced this issue Jan 18, 2025
This is a partial for #2090
lengau added a commit that referenced this issue Jan 18, 2025
This is a partial for #2090
jujubot added a commit to juju/juju that referenced this issue Jan 21, 2025
#18670

This adds a header for exporting the contents of a model to a bundle so that the Charmcraft docs can reference it directly using intersphinx.

## Checklist

<!-- If an item is not applicable, use `~strikethrough~`. -->

- [ ] ~Code style: imports ordered, good names, simple structure, etc~
- [ ] ~Comments saying why design decisions were made~
- [ ] ~Go unit tests, with comments saying what you're testing~
- [ ] ~[Integration tests](https://github.com/juju/juju/tree/main/tests), with comments saying what you're testing~
- [ ] ~[doc.go](https://discourse.charmhub.io/t/readme-in-packages/451) added or updated in changed packages~

## QA steps

Check that the header is exported in the Sphinx `objects.inv` file. Using [sphobjinv](https://github.com/bskinn/sphobjinv) this can be done with:

```
sphobjinv suggest -t 50 objects.inv bundle
```

## Documentation changes

Just this

## Links

Blocker for canonical/charmcraft#2090
lengau added a commit that referenced this issue Jan 21, 2025
This is a partial for #2090, containing only what is currently in rST on
main. Once #2083 is merged we can do the rest.

I've also made a few tweaks to formatting related to those links

---------

Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant