freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Ouverte

#927 ouverte le 6 nov. 2018

Voir sur GitHubGuide contributeur
 (2 commentaires) (2 réactions) (0 personne assignée)Ruby (2 598 forks)batch import
docs/updatehelp wanted

Métriques du dépôt

Stars
 (38 907 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Direction de recherche
Cette issue suggère de remplacer l'archive obsolète de la documentation Chef par du contenu extrait de https://docs.chef.io/cookbooks.html. Comme il n'y a pas de PR ou de commentaires récents, commencez par examiner comment d'autres sources de documentation sont extraites dans la base de code devdocs (probablement dans le répertoire 'lib/docs/scrapers'). Vérifiez l'extracteur Chef existant, s'il existe, et adaptez le pour analyser la nouvelle structure HTML. Notez que la documentation officielle de Chef a pu changer depuis 2018, donc vérifiez la structure actuelle de la page avant de l'implémenter.
Stack technique
ruby
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitRuby
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75