chaoss
Tracking: CHAOSS Community Handbook -> Knowledgebase
Summary
Track topics and content in the process of being created or maintained for future inclusion in the future CHAOSS website knowledgebase.
Background
In the D.E.I. Working Group and others, there is documentation and information about community workings that need to go somewhere. The CHAOSS Handbook is the current place we put this information, but the access is uncertain and there is a proposed mentored project happening this round for adding a knowledgebase to the CHAOSS website. The purpose of this issue is to track different pieces of documentation that are either newly created or updates to existing content, so they can then be implemented on the future CHAOSS website knowledgebase.
Details
Docs To be Added
- [ ] Mentored Projects documentation (@kristiprogri): Unifying documentation, best practices, and steps for organizers of mentored project programs, e.g. Outreachy, GSoC, GSoD, etc.
- [ ] Newcomer Slack Bot documentation (@ElizabethN): Include docs from the chaoss-slack-bot repo
- [ ] Metrics that are not going back under review documentation
- One issue to translations once changes have been made
- Update the spreadsheet
- [ ] Metrics that are going back under review documentation
- Single issue per metric for new translation
Docs To be Edited/Updated
- [ ] CHAOSScast documentation (@ElizabethN): This set of docs is really out of date and needs to be updated.
- [ ] Website information (@klumb): This set of docs needs to be updated.
- [ ] Metrics Release Process
- [ ] Terminology: This doc is missing key terms like "metrics" and "metrics models" and "focus areas" should be updated
- [ ] Internal Docs We need to make sure any administrative docs kept in the CHAOSS project Google Drive are referenced in the appropriate places of the Handbook
- [ ] Metric definition has changed in a substantial way
Outcome
Important efforts on documenting the CHAOSS Community are not lost during this time of transition
cc @klumb: we decided in the DEI Working Group to start this issue so that additions to the handbook/knowledgebase don't get lost. We can let other working groups know that if they're adding or creating docs to just put a placeholder here for future inclusion, as @jwflory mentioned above.
@Ruth-ikegah @xiaoya-yaya as you both finish up the Handbook GSoD project, can you confirm for me that these points are covered somewhere in the new docs? Then I'll be able to close this issue. Thank youuuuu 🙏 😍
Docs to be added
- [x] The mentorship projects documentation is unified under the how-to-contribute/mentorship folder
- [x] The Slack Bot documentation
- [x] The metrics review related documentation is described in the metric contribution guide and metrics release page
Docs To be Updated
Yes, I believe these have been updated, perhaps need to be confirmed and reviewed by the community.
