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 (2,598 forks)batch import
docs/updatehelp wanted

Repository metrics

Stars
 (38,907 stars)
PR merge metrics
 (Avg merge 30d 13h) (8 merged PRs in 30d)

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

Research direction
Inspect the current Chef documentation source in the repository and update the scraper or documentation loading logic to fetch from the new official Chef docs page at https://docs.chef.io/cookbooks.html.
Tech stack
ruby
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRuby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75