freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

#927 opened on Nov 6, 2018

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Ruby (38,907 stars) (2,598 forks)batch import
docs/updatehelp wanted

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

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rubyweb scrapingChef documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue suggests replacing the outdated Chef docs archive with scraped content from https://docs.chef.io/cookbooks.html. Since no PRs or recent comments exist, start by examining how other docs sources are scraped in the devdocs codebase (likely in the 'lib/docs/scrapers' directory). Check the existing Chef scraper if any, and adapt it to parse the new HTML structure. Note that the official Chef docs may have changed since 2018, so verify the current page structure before implementing.