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

added adr with user docs navigation proposal #4118

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/adr/0016-release-ordering.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Status

Proposed
Accepted
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is just taking the opportunity to update this ADR status


## Context

Expand Down
52 changes: 52 additions & 0 deletions doc/adr/0017-documentation-categories-navigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 0017. Defining user documentation categories

## Status

Proposed

## Context

Weave GitOps user documentation could be found here https://docs.gitops.weave.works/docs/intro-weave-gitops/

It has navigation menu on the left hand side ![documentation-navigation.png](imgs%2Fdocumentation-navigation.png)
To help users finding relevant information in a natural way.

User documentation is regularly added by prodeng with two possible scenarios:
- i am extending existing section so i dont need to do decisions in terms of navigation.
- i am adding new page that might require a new navigation item so i need to do decision on where to add it.

Given that we dont have explicit guidance on this topic, it is likely that two docs contributors might follow different
considerations that might resul in inconsistent navigtion translating into user experience degration.

In order to help mitigating this risk, we decide to raise this ADR that defines the principle ruling the navigation
design and the categories to think about when adding documentation that requires navigation.

## Decision

### Design Principles

1. Navigation should intuitively follow the lifecycle of a platform engineer using the product.
2. The lifecycle the Platfrom engineer transitions is:
- Platform engineer gets started with the product or day 1.
- Platform engineer gets started with the product features or day 1.
- After got started it gets into day 2 or operating the product.
- After the platform engineer looks into how to expand the product reach by integrating with other tools.

### Categories

Matching the lifecycle, we have the following categories

1. Introduction / Getting Started = Our current one
2. Capabilities: it includes cluster mangements, gitopssets, etc …
3. Operations -> this includes anything ops: monitoring, logginc, etc
4. Integrations -> other systems that we integrate -> this includes Backstage
5. Guides / Tutorials

### Categories in Practice

// to expand on why the existing documentation matches categories

## Consequences

Now we have some support to do aligned decisions regarding where to put new documentation that translates into new navigation items.

Binary file added doc/adr/imgs/documentation-navigation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading