Skip to content

Conversation

@dwilding
Copy link
Contributor

@dwilding dwilding commented Aug 7, 2025

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:

  • Use alphabetical order
  • Drop "docs" (@dimaqq I think you raised that during the discussion)
  • Customise the spacing & sizing to match the "contents" block

@dwilding dwilding marked this pull request as ready for review August 7, 2025 03:23
Comment on lines 12 to 20
/* 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;
}
Copy link
Contributor Author

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?

Copy link

@SecondSkoll SecondSkoll Aug 7, 2025

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@james-garner-canonical james-garner-canonical left a 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.

Copy link
Collaborator

@tonyandrewmeyer tonyandrewmeyer left a 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/)"
Copy link
Collaborator

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?

Copy link
Contributor Author

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.

@tmihoc
Copy link
Member

tmihoc commented Aug 7, 2025

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 debug-hook are really for charmers, though there too maybe one could argue they're about troubleshooting your Juju deployment, albeit a corner that charmers will tend to engage with especially. Enough with the hairsplitting: I'll file Jubilant under Build charms and Juju remains solidly under Use charms.

@dwilding
Copy link
Contributor Author

dwilding commented Aug 7, 2025

Changes from the Juju implementation = improvements; mind if I steal them all?

Please go ahead!

I'll file Jubilant under Build charms and Juju remains solidly under Use charms.

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.

@tonyandrewmeyer
Copy link
Collaborator

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 😉.

@dwilding
Copy link
Contributor Author

dwilding commented Aug 8, 2025

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.

@dwilding dwilding merged commit 40dc1fe into canonical:main Aug 8, 2025
43 checks passed
@dwilding dwilding deleted the add-related-links branch August 8, 2025 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants