Skip to content
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

Closed
Lauro235 opened this issue May 26, 2023 · 7 comments
Closed

Improve Documentation please #32

Lauro235 opened this issue May 26, 2023 · 7 comments

Comments

@Lauro235
Copy link

Lauro235 commented May 26, 2023

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.

  1. Click Start commit, and choose to make a new branch named ci.
  2. Click Propose a new file.
  3. Click Create pull request.
@cmwilson21
Copy link
Contributor

@Lauro235 Thanks for opening an issue. We are currently updating the Skills courses, I'll go ahead and triage this for review.

@m-den-01A
Copy link

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)
image

Suggested Edits - please include screenshots!

Step 8 before-and-after:

  • 8. Click Start Commit, and choose to make a new branch named ci
  • 8. Select 'Commit Changes..." (at the top-right)
image

Step 9 before-and-after:

  • 9. Click Propose a new file.
  • 9. At the bottom of the box that pops-up:
    • Select create a new branch for this commit and start a pull request
    • Name it ci
    • Click Propose Changes
image

Step 10 before-and-after:

  • 10. Click Create Pull Request
  • 10. On the next screen, select Create Pull Request
image

@Lauro235
Copy link
Author

Lauro235 commented Jun 14, 2023

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.

@cmwilson21
Copy link
Contributor

@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.

@kcjonesevans
Copy link

kcjonesevans commented Jun 15, 2023

@cmwilson21 do you have a solution for how to get the step 1 action to move on to step 2? If someone has no experience with actions they will not know how to inspect the actions in place to get them to pass and move on to the next step making this course unusable.

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.

@sinsukehlab
Copy link
Contributor

Resolved in #51

@hectorsector
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants