nebari-dev / nebari-dev/nebari-docs
[DOC] - Enable versioning
Nobody has claimed this yet.
- 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
Version the documentation allows users on different versions of Nebari to access reliable documentation.
Currently, older docs are either removed or we actively add notes and warnings about features added/removed in various versions.
The old docs are only available in the git history, and hard to.find because we don't have tags for each Nebari release.
Steps to Resolve this Issue
We can enable versioning in Docusaurus https://docusaurus.io/docs/versioning#tagging-a-new-version.
Or, at minimum, start cutting tags in the Docs corresponding to each release.
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 versioning guide linked in the issue, then inspect how this documentation repository handles releases and its Git history. Done means older Nebari documentation is accessible by version, either through Docusaurus versioning or release-aligned tags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100