Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(docs): invalid yaml in example #28198

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 14, 2023
Merged

fix(docs): invalid yaml in example #28198

merged 2 commits into from
Sep 14, 2023

Conversation

priyanuj-gogoi
Copy link
Contributor

Why:

To fix the invalid YAML (example #1) in About GitHub's form schema which shows an error:

Nested mappings are not allowed in compact mappings at line 5, column 18

Added double-quotes to YAML placeholder key's value to interpret the colon before Example text as literal value.

Closes: #28197

What's being changed (if available, include any code snippets, screenshots, or gifs):

Added double-quotes to the value of placeholder YAML key.

- placeholder: Example: macOS Big Sur
+ placeholder: "Example: macOS Big Sur"

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.

  • For content changes, I have completed the self-review checklist.

@welcome
Copy link

welcome bot commented Sep 13, 2023

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 13, 2023
@github-actions
Copy link
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md fpt
ghec
ghes@ 3.10 3.9
fpt
ghec
ghes@ 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review communities Content related to Communities and removed triage Do not begin working on this issue until triaged by the team labels Sep 13, 2023
@cmwilson21
Copy link
Contributor

@priyanuj-gogoi Thank you for opening a PR and linking it to your issue! ✨

I'll get this triaged for review! ⚡

subatoi
subatoi approved these changes Sep 14, 2023
View reviewed changes
Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for spotting this and submitting a fix ✨

@subatoi subatoi added this pull request to the merge queue Sep 14, 2023
Merged via the queue into github:main with commit ccb912c Sep 14, 2023
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

@commit-lint commit-lint bot mentioned this pull request Sep 22, 2023
Open
Adawntoremember
Adawntoremember reviewed Dec 2, 2023
View reviewed changes
Copy link

@Adawntoremember Adawntoremember left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for stirring me in the right direction.

Adawntoremember
Adawntoremember reviewed Dec 2, 2023
View reviewed changes
Copy link

@Adawntoremember Adawntoremember left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the help and support

...ing-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md
@@ -28,7 +28,7 @@ For example, the following form definition includes four form elements: a text a
attributes:
label: Operating System

This comment was marked as spam.

Sign in to view

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Adawntoremember Adawntoremember Adawntoremember left review comments

@subatoi subatoi subatoi approved these changes

Assignees
No one assigned
Labels
communities Content related to Communities content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Invalid YAML example
4 participants
@priyanuj-gogoi @cmwilson21 @subatoi @Adawntoremember