-
Notifications
You must be signed in to change notification settings - Fork 125
docs: add related doc links to homepage #1959
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
Conversation
docs/_static/project_specific.css
Outdated
| /* For the "related links" block, use the same spacing & sizing as the "contents" block */ | ||
| .relatedlinks-title-container { | ||
| padding: var(--toc-title-padding); | ||
| padding-top: var(--toc-spacing-vertical); | ||
| } | ||
| .relatedlinks { | ||
| font-size: var(--toc-font-size); | ||
| line-height: 1.3; | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SecondSkoll I feel it would be nice if the spacing & sizing of the "related links" block matches the "contents" block. But there might be a history behind the current styling. What's your opinion about me adding these customisations to canonical-sphinx-extensions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was all done by Ruth. I don't have context, current or historical as I haven't used it. Happy for you to commit changes upstream though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've opened canonical/canonical-sphinx-extensions#74
james-garner-canonical
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks nice! Alphabetical sorting for the win.
tonyandrewmeyer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! A good set and a good order, I feel.
| @@ -1,3 +1,7 @@ | |||
| --- | |||
| relatedlinks: "[Charmcraft](https://documentation.ubuntu.com/charmcraft/stable/), [Charmlibs](https://canonical-charmlibs.readthedocs-hosted.com/), [Concierge](https://github.com/canonical/concierge), [Jubilant](https://documentation.ubuntu.com/jubilant/), [Juju](https://documentation.ubuntu.com/juju/3.6/), [Pebble](https://documentation.ubuntu.com/pebble/)" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can these (other than Concierge) be interspinx links instead? Or do we not have a ref to link to that is the base page for each of the sites?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately not. As far as I understand the related-links extension, we need to use absolute URLs.
|
Changes from the Juju implementation = improvements; mind if I steal them all? One challenge in Juju is that I want to (a) include the Juju ecosystem docs link (the one to juju.is/docs which shows all of these docs sets in context) as well as (b) group the Juju thingies. About (b): It's a funny one because Jubilant is a way to do Juju but it really only serves charmers. Maybe the right grouping here is into Use charms and Build charms. It would be an interesting way to bring the old logic back in, even as it remains a bit faulty -- as in, Juju is also relevant if you're building charms, at least, in the real-life testing phase, (which is maybe an argument to keep filing that under Use charms, though Juju things such as |
Please go ahead!
That sounds good to me. One could use Jubilant as a general-purpose way to drive Juju, but as developed it's intended for charm integration testing. |
In breaking news, this came up in the Charm Tech team-only today, and the intention going forward is that we won't be pushing that line any more. It's still the primary intended use-case, and we were always open to it being used elsewhere, but we'll drop the language around integration testing being the use case. Basically, in its short life so far, Jubilant got too popular to stay in its lane 😉. |
|
I've removed the CSS customisation from this PR. That's moved upstream, to canonical/canonical-sphinx-extensions#74. When the canonical-sphinx-extensions package is next published, Ops docs will get the updated CSS on the next rebuild. |
Inspired by juju/juju#20358, this PR adds a "related links" block to the docs homepage, with links to related docs in the charming ecosystem.
Preview
Differences from the Juju implementation: