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

Conversation

enekofb
Copy link
Contributor

@enekofb enekofb commented Nov 2, 2023

just draft to have further discussions

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

@lasomethingsomething
Copy link
Contributor

IMO the proposed categories are quite broad as to be almost meaningless. If I saw "Operations" I would not know to expect what looks like observability. And sections like "guides/tutorials" end up becoming catch-all buckets where people stash things when they don't know where else to put them (this already happened and I emptied out almost all of the "Guides" section to make the content discoverable).

I'd propose the following, at minimum (users do NOT want to spend a lot of time digging for information):

  • Getting Started
  • Application Development (content for the app dev persona); underneath can be another level/drop-down with the topics listed
  • Platform Engineering (content for the platform eng persona); ""
  • Observability (in place of the proposed "Operations" category)
  • Tutorials (restricted only to content that is actually how-to--the user guide in itself is a how-to but a tutorial is more specific than that)

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.

2 participants