Archive the docs
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a Chef User or a SA, I may need documentation for past versions
Description
The Chef docs Archive is out of date.
The source is the chef/docs-archive
A list of all versions of Chef
Definition of Done
- Add all major versions to
chef/docs-archive - Create new pipeline that delivers Hugo docs
- Confirm that we can deliver in both Sphinx and Hugo
- Create new epics to backfill minor versions
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 chef/docs-archive repository and the listed Chef version history. Review how the existing archive delivers Sphinx documentation, then determine the Hugo pipeline needed for all major versions. Done means the archive includes those versions, both Sphinx and Hugo delivery are confirmed, and minor-version backfill epics are created.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- hugo
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100