-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Addresses review comments on Issue 105 #106
Addresses review comments on Issue 105 #106
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @astroDimitrios! 🥳
We discussed:
- moving the first paragraph to the next section (I find that opening chunk of text a little overwhelming)
- adding a "Prerequisites" heading so that it shows in the left hand panel
but that first paragraph is in a special file that doesn't recognise any headings, so we agreed to leave it as it is, but I just had a thought 🤪 Would it be possible to add an opening sentence like: "Welcome to the Introduction to Git and GitHub training! This page contains learning outcomes and setup that must be completed before participating in the training" or equiavalent? Then go into the version control summary?
Would it be possible to move the Version control
link to the Version Control System
text in the next sentence, please?
Should the "Your instructor and organisation" sentence in the "Passkeys" section also be removed? 🤔
We also just discussed:
- me opening a new issue at https://github.com/MetOffice/azure-spice-docs for the unticked item in the original issue Feedback from the training: Summary and Setup episode #105
- making the "Long Terminal Prompts" section an expandable section
- making the "How to get help" part a full section near the top of the page
- moving the learning outcomes into their own tab, so all the outcomes from https://github.com/MetOffice/Science-Git-Migration-Project/issues/56#issuecomment-2511167781 can be listed 😊
Thanks @astroDimitrios! 🎉 I believe the outstanding issues are:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One very minor additional suggestion 😊
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@astroDimitrios would prefer the comment at point 2 above remains, so the only outstanding issues are opening new issues. Approving 🥳
An Issue has been created on the original SWC lesson to discuss moving the Summary and Setup intro text to the first episode: |
I added a comment to https://github.com/MetOffice/azure-spice-docs/issues/194#issuecomment-2602427619 😊 |
Auto-generated via `{sandpaper}` Source : 909f4e9 Branch : main Author : Dimitrios Theodorakis <[email protected]> Time : 2025-01-20 13:30:27 +0000 Message : MetOffice#106 Addresses review comments on Issue MetOffice#105 Summary and Setup feedback * Addresses review comments on Issue 105 * Address review comments * Add version number disclaimer and note about nano and cat command usage
Auto-generated via `{sandpaper}` Source : 858da6b Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2025-01-20 13:32:13 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 909f4e9 Branch : main Author : Dimitrios Theodorakis <[email protected]> Time : 2025-01-20 13:30:27 +0000 Message : MetOffice#106 Addresses review comments on Issue MetOffice#105 Summary and Setup feedback * Addresses review comments on Issue 105 * Address review comments * Add version number disclaimer and note about nano and cat command usage
Auto-generated via `{sandpaper}` Source : 858da6b Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2025-01-20 13:32:13 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 909f4e9 Branch : main Author : Dimitrios Theodorakis <[email protected]> Time : 2025-01-20 13:30:27 +0000 Message : MetOffice#106 Addresses review comments on Issue MetOffice#105 Summary and Setup feedback * Addresses review comments on Issue 105 * Address review comments * Add version number disclaimer and note about nano and cat command usage
Fixes #105
Fixes #104