Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upFix indentation inside Code Examples #271
Open
Conversation
In the Code Examples section, the YAML shown looks like, but is not, a valid GitHub Actions workflow file. The `schedule:` section is inside the `on:`. This helps the reader understand the context better that `schedule:` is not a standalone block, but is supposed to be in the `on:` section.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
|
Thanks for opening a pull request @dtinth! I'll let the @github/docs-content-ecosystem team know this is ready for review |
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.
Why:
In the Code Examples section, the YAML shown looks like, but is not, a valid GitHub Actions workflow file. The
schedule:section is inside theon:where the docs shows it as a separate block.What's being changed:
The indentation has been fixed to make the code example a valid workflow.
This helps the reader understand the context better that
schedule:is not a standalone block, but is supposed to be in theon:section. It also prevents attentive readers from getting distracted by invalid YAML syntax in the code block while reading the guidelines.Check off the following: