Skip to content

Commit

Permalink
further wording edits to github workflows docs (mainly clarifying tha…
Browse files Browse the repository at this point in the history
…t its run on PRs as well)
  • Loading branch information
Tridecatrix committed Oct 17, 2024
1 parent b450152 commit 6230cb5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions en/contributing/how-to-improve-the-help-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,13 @@ To edit more than one file at a time, add screenshots, and for other more advanc

### Github workflows

In order to find broken links and find Markdown errors, you can use the "Check Links" and "Lint" workflows respectively. These are provided in `.github/workflows` and run each time you push to the documentation repo. You are recommended to check the results of these workflows on your local fork after pushing changes to it to catch minor mistakes.
Two workflows are triggered each time you push or pull request.

Check failure on line 59 in en/contributing/how-to-improve-the-help-page.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces [Expected: 0 or 2; Actual: 1]

en/contributing/how-to-improve-the-help-page.md:59:64 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
- Lint workflow checks for minor Markdown formatting style issues.

Check failure on line 60 in en/contributing/how-to-improve-the-help-page.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines [Context: "- Lint workflow checks for min..."]

en/contributing/how-to-improve-the-help-page.md:60 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Lint workflow checks for min..."]
- Check links workflow checks for broken links, e.g. to images or external resources.

On your local fork, you can check the results of the workflows in the Actions tab > All actions panel on Github as shown below. Click on a specific workflow and its run to check it.
On PRs, you are able to view the results directly on the PR (though you have to wait for a maintainer to approve running the workflow). You can also view the results on the local fork of the repo that you pushed to (which you are recommended to check first so you can fix mistakes before the maintainer has to look at it).

Check failure on line 63 in en/contributing/how-to-improve-the-help-page.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces [Expected: 0 or 2; Actual: 1]

en/contributing/how-to-improve-the-help-page.md:63:323 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

On your local fork, you can check the results of the workflows in the Actions tab > All actions panel on Github as shown below. Click on a specific workflow and its run to check the results.

### Notes on links workflow

Expand Down

0 comments on commit 6230cb5

Please sign in to comment.