docs
docs copied to clipboard
The example YAML in the issue form schema is incorrect
Code of Conduct
- [X] I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#about-githubs-form-schema
What part(s) of the article would you like to see updated?
In the example YAML under the section "About GitHub's form schema" is incorrect and will render JSON in the resulting form dropdown. This section:
- type: dropdown
attributes:
label: Version
description: What version of our software are you running?
multiple: false
options:
- label: 1.0.2 (Default)
- label: 1.0.3 (Edge)
In attributes.options
having label:
before the drop down item text will result in the following rendering:
Removing label
will correct the issue:
- type: dropdown
attributes:
label: Version
description: What version of our software are you running?
multiple: false
options:
- 1.0.2 (Default)
- 1.0.3 (Edge)
Yielding:
Additional information
No response
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.
@stockholmux Thanks so much for opening an issue! We appreciate all the info and screenshots!
I'll triage this for the team to take a look :eyes:
Thanks so much for opening this issue! You or anyone else can open a PR with a fix 🔨.
Closed via https://github.com/github/docs/pull/23577 💖