-
Notifications
You must be signed in to change notification settings - Fork 111
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
Improve Documentation please #32
Comments
@Lauro235 Thanks for opening an issue. We are currently updating the Skills courses, I'll go ahead and triage this for review. |
New to GitHub. The skills courses have been a great way to learn basics. One thing I found confusing at first was mis-alignment between instructions and what I see on my screen. Offering suggestions below. Screenshots go a long way. Instructions as of 6/13/23[reference page](https://github.com/skills/test-with-actions/blob/main/.github/steps/1-add-a-test-workflow.md) Suggested Edits - please include screenshots!Step 8 before-and-after:
Step 9 before-and-after:
Step 10 before-and-after:
|
Looking back I can see my 'issue' may not be helpful to everyone, but I broadly feel that the more precise the instructions, the less the user has to worry about learning the GUI interface and the more they can focus on the content of Github actions. I appreciate the response and the updating of documentation. |
@m-den-01A Thank you for the suggestions! I can confirm that screenshots will be updated as we roll through updating the courses in general. We appreciate your suggestions on the matter! @Lauro235 Feedback is always helpful! Thank you again for sharing with us. |
@cmwilson21 Update: if you are reading this and are stuck on the first step, don't delete anything from the simple workflow template as the instructions tell you to and it will pass the checks and move to step 2. |
Resolved in #51 |
Thanks for the very helpful feedback, folks. I think this course has gotten some improvements since it was opened and, although still not perfect, the feedback in this issue may be outdated now. |
As far as I can tell, the documentation for the test-with-actions lesson template is very out of date.
The steps from 8 - 10 cannot be followed. The language doesn't match what is actually seen on the screen. Not only that but no prompt is given to create a new branch or
Create a pull request
.Perhaps I'm just misunderstanding the instructions but regardless, despite my best faith attempt at following the lesson, I cannot seem to make sense of the instructions as listed below.
The text was updated successfully, but these errors were encountered: