docs: updates after user testing to github.md #362
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Edited GitHub Tutorial for required command changes, clarity, and formalizing of language.
benroose
changed the title
|
@jpower432 numbering is fixed and the PR title/description updated. Please let me know if you need anything further done. |
gvauter
requested changes
Oct 11, 2024
docs/tutorials/github.md
Outdated
|
|
||
| 1. Open to your GitHub repo in a web browser. | ||
| 1. Open the remote workflow GitHub repository in a web browser. |
There was a problem hiding this comment.
nitpick: maybe remove "workflow"? Just to avoid any confusion that there may be more than 1 remote repo involved.
docs/tutorials/github.md
Outdated
| @@ -104,6 +130,6 @@ Now it's time to run our first trestlebot action! We will go ahead and create o | |||
|
|
|||
| 6. Click `Run Workflow` | |||
|
|
|||
| Once the workflow has completed you should have a new Pull Request containing the files trestlebot generated for the component definition. After reviewing the files you can go ahead and merge the PR! | |||
| Once the workflow job has completed, there will be a new Pull Request containing the files trestlebot generated for the component definition. After reviewing the commit changes, the Pull Request can then be merged into the main branch! | |||
There was a problem hiding this comment.
"commit changes" --> "committed changes"?
There was a problem hiding this comment.
Hi @gvauter, sorry for delay. Those minor changes are now committed in the merge request. Please let me know if you see any other fixes needed prior to giving it your "go ahead."
There was a problem hiding this comment.
Looks good to me, thanks @benroose!
Minor documentation changes for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Edited GitHub Tutorial for required command changes, clarity, and formalizing of language.
Type of change
How has this been tested?
Ran through tutorial on a Fedora Linux 39 workstation
Test Configuration:
Checklist