freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

#927 aperta il 6 nov 2018

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

Metriche repository

Star
 (38.907 star)
Metriche merge PR
 (Merge medio 23g 15h) (7 PR mergiate in 30 g)

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

Direzione di ricerca
L'issue suggerisce di sostituire l'archivio obsoleto della documentazione Chef con contenuti estratti da https://docs.chef.io/cookbooks.html. Poiché non esistono PR o commenti recenti, inizia esaminando come vengono estratti altri sorgenti di documentazione nella codebase di devdocs (probabilmente nella directory 'lib/docs/scrapers'). Controlla l'estrattore Chef esistente, se presente, e adattalo per analizzare la nuova struttura HTML. Nota che la documentazione ufficiale di Chef potrebbe essere cambiata dal 2018, quindi verifica la struttura attuale della pagina prima di implementare.
Tech stack
ruby
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitRuby
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75