Improve Documentation for Attendee List Generation Scripts.
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức phù hợp với người mới
- 55/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- javascript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với util/README.md và so sánh các hướng dẫn trong đó với util/create-attendee-handle-map.js và util/map-handles-to-catchup-attendees.js. Ghi lại rằng các script này hỗ trợ Attendee List Generation, thứ tự chạy chúng và thư mục cần dùng để chạy chúng. Hoàn thành khi README giải thích rõ cách tạo các tệp attendees.adoc cho các session trong summary/sessions.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
- 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
- Ngôn ngữ chính
- JavaScript
- Star
- 19
- Fork
- 18
- Merge trung bình
- 3 ngày 6 giờ
- Pull request đã merge (30 ngày)
- 3
Chuẩn bị môi trường
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của OurTechCommunity/catchup
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
OurTechCommunity/catchup#347 · 4 bình luận ·
-
Clean Up Config FilesĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 55/100
OurTechCommunity/catchup#303 ·
-
Update `CONTRIBUTING.md`Đang mởdocumentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 38/100
OurTechCommunity/catchup#258 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 48/100
OurTechCommunity/catchup#184 · 2 bình luận ·
-
CI/CD good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 55/100
OurTechCommunity/catchup#172 · 1 bình luận ·
Tất cả issue của OurTechCommunity/catchup
Issue tương tự
-
curriculum documentation quality
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
githubnext/gh-aw-workshop#3897 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 91/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Add: RSV Honduras FeedĐang mởcheck:failed feeds:add
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
iptv-org/database#36179 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Bug] : Main navigation "Upcoming Events" link navigates to /events/ without query parameterĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày