freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

#927 ouverte le 6 nov. 2018

Voir sur GitHub
 (2 commentaires) (2 réactions) (0 assignés)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.

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Rubyweb scrapingChef documentation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.