-
Notifications
You must be signed in to change notification settings - Fork 151
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
enekofb
wants to merge
1
commit into
main
Choose a base branch
from
adr-user-docs-navigation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
## Status | ||
|
||
Proposed | ||
Accepted | ||
|
||
## Context | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
this is just taking the opportunity to update this ADR status