nebari-dev / nebari-dev/nebari-docs
[DOC] - Start adding when features were added or changed in the docs.
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
We should start adding when features were added or changed in the docs. For example, Nebari workflow controller was added just after the May release, so it's already in the docs, but it won't work for most Nebari deployments. It'd be nice to have some way to indicate in the docs that it is a feature as of the 2023.7.1 release or similar.
Alternatively (and I favor this option), we need to have a branch of docs that we only deploy along with a Nebari release. We can then merge new feature docs there until we have a release for Nebari.
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
Review how this repository currently deploys documentation and ties documentation to Nebari releases. Compare release-date indicators with a release-aligned documentation branch, then record the chosen approach and define how contributors can tell that documentation matches a released feature.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100