New checkout docs #2509
New checkout docs #2509
Conversation
|
Ignore all the failed checks - I was trying to get Netlify previews to work. These checks are not necessary to merge. |
Update language (teaching demo, not lesson demo) Co-authored-by: Kelly Barnes <[email protected]>
Co-authored-by: Kelly Barnes <[email protected]>
Co-authored-by: Kelly Barnes <[email protected]>
|
If I merge to develop now, it will be live at https://carpentries.github.io/amy/, right? The information here won't be correct until Monday so I would like to see it merged when the other changes are deployed. |
|
Looks like we need to have stable docs and @maneesha the easiest way is for me to mark this PR as v4.3 and merge it after the production AMY has been upgraded. |
docs/users_guide/community_index.md
Outdated
| Note the additional information required for each activity: | ||
|
|
||
| Carpentries Instructor trainees can log in to AMY to view their checkout progress towards their Instructor badge. Due to the structure of our checkout tracking progress, all steps towards checkout may not be included here. If your instructor badge is correctly displayed, you are in good standing. | ||
| * Attended a regional meetup, skill-up, or other community meeting: Date of event and description of event (as additional information) | ||
| * Submitted a contribution to a Carpentries repository on GitHub: Date of contribution and link to contribution. This must be to a repo in a [Carpentries organisation](https://docs.carpentries.org/topic_folders/communications/tools/github_organisations.html). | ||
| * Served as an Instructor or a helper at a Carpentries workshop: Date of workshop and link to workshop website | ||
| * Other: Date and description of contribution (as additional information) |
There was a problem hiding this comment.
This information may be better provided in a tabular format (with a heading that we can link to from the admin guide too!) Suggestion below:
| Note the additional information required for each activity: | |
| Carpentries Instructor trainees can log in to AMY to view their checkout progress towards their Instructor badge. Due to the structure of our checkout tracking progress, all steps towards checkout may not be included here. If your instructor badge is correctly displayed, you are in good standing. | |
| * Attended a regional meetup, skill-up, or other community meeting: Date of event and description of event (as additional information) | |
| * Submitted a contribution to a Carpentries repository on GitHub: Date of contribution and link to contribution. This must be to a repo in a [Carpentries organisation](https://docs.carpentries.org/topic_folders/communications/tools/github_organisations.html). | |
| * Served as an Instructor or a helper at a Carpentries workshop: Date of workshop and link to workshop website | |
| * Other: Date and description of contribution (as additional information) | |
| #### Information required for each Get Involved activity | |
| | Activity | Date required? | URL required? | Additional information required? | | |
| | --- | --- | --- | --- | | |
| | Attended a regional meetup, skill-up, or other community meeting | yes | no | yes, description of event | | |
| | Submitted a contribution to a Carpentries repository on GitHub | yes | yes, to a contribution to a repo in a [Carpentries organisation](https://docs.carpentries.org/topic_folders/communications/tools/github_organisations.html) | no | | |
| | Served as an Instructor or a helper at a Carpentries workshop | yes | yes, to a workshop website | no | | |
| | Other | yes | no | yes, description of contribution | | |
| #### After submitting |
(final line of suggestion just separates the table from the next paragraph)
This renders like this (ignore the dark mode, that's just my local Markdown previewer):
There was a problem hiding this comment.
@klbarnes20 approved this in #2514 (comment)
docs/users_guide/community_index.md
Outdated
|
|
||
|  | ||
|
|
||
| This will take you to a page where you can select what type of activity you are submitting and provide additional information. |
There was a problem hiding this comment.
Suggestion to go along with my other suggestion https://github.com/carpentries/amy/pull/2509/files#r1291340107
| This will take you to a page where you can select what type of activity you are submitting and provide additional information. | |
| This will take you to a page where you can select what type of activity you are submitting and provide additional information. The table below shows which information must be provided for each activity. |
|
@maneesha I'm going to apply the suggestions above, and then merge this branch. Thanks! |
Updates AMY documentation with new checkout instructions. To be merged along with deploy on 2023-08-12. Tagging @pbanaszkiewicz and @elichad