Skip to content

docs: Mimir on Juju docs - #361

Draft
sinapah wants to merge 2 commits into
mainfrom
docs/mimir-on-juju
Draft

docs: Mimir on Juju docs#361
sinapah wants to merge 2 commits into
mainfrom
docs/mimir-on-juju

Conversation

@sinapah

@sinapah sinapah commented May 26, 2026

Copy link
Copy Markdown
Contributor

Issue

Based on: grafana/mimir#15202.

Solution

Checklist

  • I have added or updated relevant documentation.
  • PR title makes an appropriate release note and follows conventional commits syntax.
  • Merge target is the correct branch, and relevant tandem backport PRs opened.

Context

Testing Instructions

Upgrade Notes

@YanisaHS YanisaHS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok I've made a lot of high-level feedback, so have fun 😅

LMK if you have questions or want to discuss!

Comment thread docs/how-to/deploy-and-manage/install.md Outdated
Comment thread docs/tutorial/index.md Outdated
Comment thread docs/tutorial/mimir-on-juju.md Outdated
Comment thread docs/tutorial/mimir-on-juju.md Outdated
Comment thread docs/tutorial/mimir-on-juju.md Outdated
Comment thread docs/how-to/integrate/configure-object-storage-for-mimir.md Outdated
Comment thread docs/how-to/integrate/configure-object-storage-for-mimir.md Outdated
Comment thread docs/how-to/integrate/configure-object-storage-for-mimir.md Outdated
Comment thread docs/how-to/integrate/send-metrics-to-mimir.md Outdated
Comment thread docs/how-to/integrate/send-metrics-to-mimir.md Outdated
sinapah and others added 2 commits July 7, 2026 16:30
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.
@lucabello
lucabello force-pushed the docs/mimir-on-juju branch from 6b484a7 to 7de1c93 Compare July 7, 2026 14:33
@lucabello lucabello self-assigned this Jul 7, 2026
@lucabello

Copy link
Copy Markdown
Contributor

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
lucabello requested a review from YanisaHS July 7, 2026 15:07
@YanisaHS

YanisaHS commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

@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):

  • COS-centered deployment: Full COS solution is the main product context to the user, Mimir is one component inside it, but includes other components for the full solution.
  • Mimir-centered deployment: Mimir is the main product context to the user, using Juju/COS charms adds the operational model only, includes whatever other components are needed for that
  • Mimir (charm): The specific charm that deploys/configures Mimir, it’s not a deployment path

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

How-to guides
    Deploy and manage
    Integrate
    Configure and tune
    Validate and troubleshoot
    Product deployment paths
       Mimir on Juju
          Deploy Mimir on Juju
          Connect object storage to Mimir on Juju
          Send metrics to Mimir on Juju
       [example] Loki on Juju
       [example] Tempo on Juju

And (if needed later) add “Product deployment paths” as another under Explanation or Reference. E.g.,

Explanation
   Product deployment paths
      Mimir on Juju
         [Mimir on Juju explanation]

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 YanisaHS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Content looks good though✨

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.

3 participants