Improve Documentation for Attendee List Generation Scripts.
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 55/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- javascript
- Bereich
- documentation
Rechercherichtung
Beginne mit util/README.md und vergleiche dessen Anweisungen mit util/create-attendee-handle-map.js und util/map-handles-to-catchup-attendees.js. Dokumentiere, dass diese Skripte Attendee List Generation unterstützen, in welcher Reihenfolge sie ausgeführt werden müssen und aus welchem Verzeichnis sie ausgeführt werden müssen. Die Aufgabe ist erledigt, wenn das README klar erklärt, wie attendees.adoc-Dateien für Sitzungen in summary/sessions generiert werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
- The https://github.com/OurTechCommunity/catchup/blob/main/util/README.md file documents the usage of the two scripts https://github.com/OurTechCommunity/catchup/blob/main/util/create-attendee-handle-map.js and https://github.com/OurTechCommunity/catchup/blob/main/util/map-handles-to-catchup-attendees.js that aid in generating the
attendees.adocfile for every session insummary/sessions. - The issue is that the
util/README.mddocument isn't very explicit in mentioning- What feature the two scripts are meant for (the Attendee List Generation feature).
- The order of running the scripts.
- From where (which directory) the scripts have to be run from.
- Adding this to the documentation would make it easier to use the Attendee List Generation feature.
Cc: @tusharnankani
- Vorherrschende Sprache
- JavaScript
- Sterne
- 19
- Forks
- 18
- Ø Merge
- 3 T. 6 Std.
- Gemergte PRs (30 T.)
- 3
Entwicklungsumgebung
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus OurTechCommunity/catchup
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
OurTechCommunity/catchup#347 · 4 Kommentare ·
-
Clean Up Config FilesOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 55/100
OurTechCommunity/catchup#303 ·
-
Update `CONTRIBUTING.md`Offendocumentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 38/100
OurTechCommunity/catchup#258 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 48/100
OurTechCommunity/catchup#184 · 2 Kommentare ·
-
CI/CD good first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 55/100
OurTechCommunity/catchup#172 · 1 Kommentar ·
Alle Issues in OurTechCommunity/catchup
Ähnliche Issues
-
bug good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
amponce/archive-movie-browser#354 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
saayam-for-all/webapp#1870 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Imageomics/OpenCite#66 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
chr15m/twiiit.com#20 ·
-
documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
antropos17/Aegis#629 ·
Maintainer antworten meist innerhalb von 4 Tagen