nextflow-io / nextflow-io/nextflow
Make docs of previous versions available on readthedocs
Nobody has claimed this yet.
- Dominant language
- Groovy
- Stars
- 3.5k
- Forks
- 811
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 61
Description
New feature
It is often useful to be able to browse old docs for versions that are not latest. I couldn't figure out how to browse previous docs for nextflow unfortunately.
This shouldn't be too hard to enable, it's a feature that I very often see on readthedocs.
In the URL it even says latest but I can't figure out how to get a stable doc link that's not latest: e.g. https://www.nextflow.io/docs/latest/index.html contains /latest/ - what do I need to put in to get say 22.10.1?
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 Read the Docs configuration and the current URL, https://www.nextflow.io/docs/latest/index.html, to determine how versioned builds are configured. Done means a stable URL such as /docs/22.10.1/ serves the corresponding historical documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100