OurTechCommunity / OurTechCommunity/catchup
Improve Documentation for Attendee List Generation Scripts.
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- JavaScript
- Stars
- 19
- Forks
- 18
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 3
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with util/README.md and compare its instructions with util/create-attendee-handle-map.js and util/map-handles-to-catchup-attendees.js. Document that these scripts support Attendee List Generation, the order to run them, and the directory from which to run them. Done means the README clearly explains how to generate attendees.adoc files for sessions in summary/sessions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100