Improve Documentation for Attendee List Generation Scripts.
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 55/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- javascript
- Domaine
- documentation
Piste de recherche
Commencez par util/README.md et comparez ses instructions avec util/create-attendee-handle-map.js et util/map-handles-to-catchup-attendees.js. Documentez que ces scripts prennent en charge Attendee List Generation, l’ordre dans lequel ils doivent être exécutés et le répertoire depuis lequel ils doivent être exécutés. C’est terminé lorsque le README explique clairement comment générer des fichiers attendees.adoc pour les sessions dans summary/sessions.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
- 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
- Langage dominant
- JavaScript
- Étoiles
- 19
- Forks
- 18
- Merge moyen
- 3 j 6 h
- PR mergées (30 j)
- 3
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OurTechCommunity/catchup
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
OurTechCommunity/catchup#347 · 4 commentaires ·
-
Clean Up Config FilesOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 55/100
OurTechCommunity/catchup#303 ·
-
Update `CONTRIBUTING.md`Ouvertedocumentation
Difficulté 2/5 1-3 heures Accessibilité débutants 38/100
OurTechCommunity/catchup#258 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 48/100
OurTechCommunity/catchup#184 · 2 commentaires ·
-
CI/CD good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 55/100
OurTechCommunity/catchup#172 · 1 commentaire ·
Toutes les issues de OurTechCommunity/catchup
Issues similaires
-
feature task
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
RealDevSquad/website-www#1178 ·
-
add latest sol modelOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
netlify-labs/nax#56 · 2 commentaires · 1 réaction ·
-
accessibility bug revealjs
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
quarto-dev/quarto-cli#14961 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
PnX-SI/GeoNature#4435 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
openlayers/openlayers#17648 ·
Les mainteneurs répondent en général sous 1 jour