freeCodeCamp / freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open
#927 2 comments 2 reactions 0 assignees View on GitHub
docs/update help wanted
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
13

Description

The Chef docs are created from an archive that resides here https://docs-archive.chef.io/. These docs are not updated any more, which I was told on Slack by a Chef employee (sorry for not having anything written down).
The chef docs moved to a style of documentation that is independent of the chef version, so scraping the cookbooks reference from the official docs page (https://docs.chef.io/cookbooks.html) would probably the best approach.

Contributor guide

Open the contributing guide

Research direction

Start by comparing the archived Chef docs at https://docs-archive.chef.io/ with the current cookbooks reference at https://docs.chef.io/cookbooks.html, then trace where the existing Chef documentation source is generated. Done means the project no longer relies on the outdated archive and reflects the current official documentation structure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.