[SE-2761] Address docs issues: miscellaneous minor issues
This merge request is about addressing multiple miscellaneous minor issues.
-
Newcomers should set their notifications to track changes to documentation group (issue) -
Add a description template to "Process: Pull Requests > Organization OpenCraft" (issue) -
Reorganise "Task Work Flows", move grooming points to its own section(issue) -
Confusing sentence in Task Workflows -> Internal review(issue) -
Bad link to "Testing Documentation" (issue) -
Should we be referring to "Open edX" rather than just "edX" everywhere in the handbook?(issue) -
Add terms to OpenCraft glossary (issue) -
Github email setup tips (issue) -
Add developer hardware specs to onboarding course (issue) -
Move epic ownership expectation to epic ownership description. (issue) -
Rename sprint "Grooming" to "Estimation" (issue) -
Newcomers should add their availability in the contact spreadsheet (issue)
Testing instructions
- Tempo is now a link to the glossary: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/week_1/first_sprint/3?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40first_sprint_logging_time
- Replace "groom/grooming" terms by "refine": https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/week_1/first_sprint/4?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40first_sprint_point_estimates
- Tempo and Opsgenie are now links to the glossary: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/chapter_core/first_steps_as_a_core_team_member/6?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40first_steps_as_a_core_team_member_firefighting_pager_setup
- Add tip about
direnv
: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/week_1/github_configuration/3?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40github_configuration_email_address - Add new "Hardware requirements" unit: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/chapter_newcomer/introduction_newcomer/3?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40hardware_requirements
- "Story points" are now links to glossary: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/jump_to/block-v1:OpenCraft+onboarding-dev+course+type@vertical+block@how_when_to_pick
- "Mattermost" is now a link to the glossary: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/week_1/time_management/2?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40onboarding_epic_management
- "Mattermost" is now a link to the glossary: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/task_specific/open_edx_devstack/9?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40open_edx_devstack_tips_and_tricks
- "Mattermost" is now a link to the glossary (again): https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/task_specific/open_edx_devstack/5?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40open_edx_setting_up_vagrant_devstack
- "Mattermost" is now a link to the glossary (again and again) and add a tip at the very bottom about subscribing to documentation gitlab group to get notified of any changes: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/courseware/week_1/opencraft_email_accounts_and_mailing_lists/5?activate_block_id=block-v1%3AOpenCraft%2Bonboarding-dev%2Bcourse%2Btype%40vertical%2Bblock%40opencraft_email_accounts_and_mailing_lists_notifications
- Link to "Gandi" glossary entry: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/jump_to/block-v1:OpenCraft+onboarding-dev+course+type@vertical+block@opencraft_ops_the_life_of_a_request
- Link to "Mattermost" glossary entry: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/jump_to/block-v1:OpenCraft+onboarding-dev+course+type@vertical+block@opencraft_say_hi
- Link to "Mattermost" glossary entry and add "(contact details and availability)" details: https://courses.opencraft.com/courses/course-v1:OpenCraft+onboarding-dev+course/jump_to/block-v1:OpenCraft+onboarding-dev+course+type@vertical+block@things_to_do
Jira tickets
Reviewers
Edited by toxinu