nebari-dev / nebari-dev/nebari-docs
[DOC] - Add tags for user and administrator docs
Open
Nobody has claimed this yet.
area: documentation 📖
type: maintenance 🛠
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
Docusaurus allows us to "tag" pages: https://docusaurus.io/docs/2.2.0/create-doc#doc-tags
We can use this functionality to separate "user" and "administrator" documentation, making navigation easier.
Steps to Resolve this Issue
- Add relevant tags to all the docs pages
- Link to corresponsing "tags" in the learning paths
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Docusaurus doc-tags guidance linked in the issue and inventory the documentation pages in this repository as user or administrator content. Then review the learning paths at /docs/welcome#learning-paths and connect them to the corresponding tags; done means relevant pages are tagged and the learning paths link to those tags.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100