Versioning for documentation to match daemon version
Open
Nobody has claimed this yet.
area: docs
good first issue
help wanted
level: 1
type: discussion
type: improvement
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 493
- PR merge metrics
- No merged PRs in 30d
Description
Right now the docs correspond to what's on `master`. We need docs for each daemon release so developers can see what's available in the version they are using.
https://github.com/jimporter/mike may be helpful.
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 by reviewing the documentation currently served from master and how daemon releases are represented in this repository. Evaluate whether mike can publish versioned documentation for each daemon release. Done means developers can select documentation matching the daemon version they use; the issue names no files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100