freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

Aperta il 6 nov 2018

Vedi su GitHub
 (2 commenti) (2 reazioni) (0 assegnatari)Ruby (38.907 star) (2598 fork)batch import
docs/updatehelp wanted

Descrizione

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.

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Rubyweb scrapingChef documentation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
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.