-
Notifications
You must be signed in to change notification settings - Fork 102
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
Proposal: Remove and Reorg Knowledge Base #749
Comments
This looks reasonable to me @plumbis! A few thoughts:
|
@jbw976 -
Yes! Here is a very rough demo This is only to show the nav updates. I haven't addressed any ordering, section titles or anything like that.
I struggled with this and I'm open to suggestions. I don't want to create sections with only 1 or 2 pages so I avoided having unique "Operations" and "Integrations" section and thought that "Guide" may be a good enough generic. |
Yesss, I love the more static navigation panel now @plumbis!! It's changes only if you go to the docs contributing section, but that is totally fine since that area really is more segregated than the rest of the content in user docs and KB. Having those two together in a static navigation is the most important part. Looks like the right path to me! 🙇♂️ |
Background
Since the docs reorg in #271 we've had a Knowledge Base section that has been a bit of a catch-all for docs that don't fit into the existing user docs.
Some of this content is older and needs to be revised or removed and some of it is newer, popular content.
@jbw976 also raised two good points in #473 that the KB makes the left-hand navigation dynamic and confusing and that the "Configuration Guides" is a catch-all.
Current Status
The KB currently has 16 pages, sorted here by views in the last 90 days:
Proposal
My proposal is to
/knowledge-base
directory. All existing URLs will have redirects to their new locations.This doesn't need to be done as a single PR but can be broken up on a per-page or per-section basis. For example, moving pages to Concepts can be on a per-page while the "Learn" section may make more sense as a single action.
The text was updated successfully, but these errors were encountered: