freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

#927 geöffnet am 6. Nov. 2018

Auf GitHub ansehen
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Ruby (2.598 Forks)batch import
docs/updatehelp wanted

Repository-Metriken

Stars
 (38.907 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23T 15h) (7 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Das Issue schlägt vor, das veraltete Chef Dokumentationsarchiv durch gescrapte Inhalte von https://docs.chef.io/cookbooks.html zu ersetzen. Da keine PRs oder aktuellen Kommentare existieren, beginnen Sie damit zu untersuchen, wie andere Dokumentationsquellen in der devdocs Codebasis gescraped werden (wahrscheinlich im Verzeichnis 'lib/docs/scrapers'). Überprüfen Sie den vorhandenen Chef Scraper, falls vorhanden, und passen Sie ihn an, um die neue HTML Struktur zu parsen. Beachten Sie, dass sich die offizielle Chef Dokumentation seit 2018 möglicherweise geändert hat, also überprüfen Sie die aktuelle Seitenstruktur vor der Implementierung.
Tech Stack
ruby
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitRuby
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75