docs: Mimir on Juju docs - #361
Conversation
YanisaHS
left a comment
There was a problem hiding this comment.
Ok I've made a lot of high-level feedback, so have fun 😅
LMK if you have questions or want to discuss!
Restructure the Mimir on Juju documentation set based on review: - Convert the Mimir on Juju guide from a tutorial to a how-to, moved under how-to/deploy-and-manage, wired into that index, and removed from the tutorial index. Redirect kept for the old URL. - Drop the "standalone Mimir" framing across all three docs. - Add a Background section covering Juju terminology and clarify which charms are Mimir infrastructure vs. supporting infrastructure. - Move planning content to the top of the object-storage how-to and rename it to "connect object storage" to match what it does. - Rewrite the send-metrics intro and add context on why the guide uses the OpenTelemetry Collector snap instead of a charm. - Replace the top-of-page note in the install guide with a "Deploy individual components" section at the bottom.
6b484a7 to
7de1c93
Compare
|
TODO (self): follow up with @YanisaHS on the IA question — the how-to root currently mixes product-level guides (Deploy and manage, Integrate, Migrate, Configure and tune, etc.) with component-level guides for individual charms (the three Mimir on Juju docs added in this PR). Need her input on the cleanest way to separate the two concerns without duplicating the Diátaxis structure per component. |
|
@lucabello Happy to discuss this more in depth but I’m also going to hijack your self TODO and chime in 😈 As I see it, there’s three concepts worth separating here (using Mimir as the example):
I’m noting that because I wouldn’t consider Mimir on Juju as “component-level” for Observability, to me it’s still at the end-user product-level. Not trying to nit, but just so we’re on the same page with why I’ve made my suggestions below And there’s the other consideration that (1) we need Diataxis top-level in the sidebar, and (2) the Mimir on Juju docs only have how-tos now, but that could change later Easiest solution (least disruptive, if you want to get this out soon and figure out the optimal IA later) Keep the pages where they are, add an entry point somewhere as Explanation that links to all the existing pages. It's not ideal since the user loses the navigation as soon as they leave that page, but it would give you an entry point if you need to link to one. AND Also have a manually-added small navigation block in every Mimir on Juju page that links to all the relevant docs (e.g., at the top, below the intro). You could reuse the content here with Sphinx instead of manually coping it per page. This would give every user of the page a connection to all the Mimir on Juju docs Potential actual solution (if there’s not that many “[Product] on Juju” pathways) Add a separate section like “Product deployment paths” (or “Product-centered deployment paths”, just “Deploment paths”, etc…) to each relevant Diataxis section, like And (if needed later) add “Product deployment paths” as another under Explanation or Reference. E.g., I have some reservations about this because “Product deployment paths” isn’t matched with the action-based categories of the existing section and it’s a lot of nested clicks for the user, but trying to work with what we have. This way still gives them the docs together in the sidebar, keeping them in a more “isolated” section. Very open to hearing other thoughts/suggestions though! It’s a fun problem 🎉 🎈 😊 |
YanisaHS
left a comment
There was a problem hiding this comment.
Content looks good though✨
Issue
Based on: grafana/mimir#15202.
Solution
Checklist
Context
Testing Instructions
Upgrade Notes