CONTRIBUTING lists the whole FLoRA page as generated; only its citation block is

Offen Anfängerfreundlich
#947 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
90/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
markdown, python
Bereich
documentation

Rechercherichtung

Lies die Hinweise zu generierten Pfaden in CONTRIBUTING.md und prüfe content/replication-hub/flora/_index.md zusammen mit der Funktion update_flora_index in scripts/update_fred_citation.py. Aktualisiere die Hinweise so, dass sie besagen, dass nur der Block zwischen den Flora-Zitationsmarkierungen generiert wird; fertig ist die Änderung, wenn nicht mehr der Eindruck entsteht, der Rest der Seite werde generiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

CONTRIBUTING.md lists content/replication-hub/flora/_index.md among generated paths and tells contributors not to edit generated output. Only the block between <!-- flora-citation-start --> and <!-- flora-citation-end --> is generated: scripts/update_fred_citation.py (update_flora_index) replaces that block and leaves the rest of the file unchanged. The prose is maintained by hand, and the source sheet or form the guidance points to does not hold it.

Suggested change: say that only the citation block on that page is generated.

Raised by the cubic review on #940, and checked against the script and data-processing.yml.

Vorherrschende Sprache
HTML
Sterne
42
Forks
33
Ø Merge
16 Std. 3 Min.
Gemergte PRs (30 T.)
121

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus forrtproject/forrtproject.github.io

Alle Issues in forrtproject/forrtproject.github.io

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.