-
Notifications
You must be signed in to change notification settings - Fork 191
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.
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
Update issue templates #4301
Update issue templates #4301
Conversation
Documentation previews: |
This comment was marked as resolved.
This comment was marked as resolved.
Updating to make the YAML valid.
Empty placeholder elements were causing validation errors, so I removed them for now. We can add them back once we have actual placeholder text; this was just to get the form to build correctly. |
Now that we can preview the form, overall it's pretty long, and could feel overwhelming or even discourage folks from creating issues. I think we could streamline it by combining a few fields, but it's hard to convey large-scale suggestions with GitHub's line-edit review UI. So I created an alternate PR (#4308) to show one way we could trim down without losing content. Maybe we could discuss in our next team sync? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One line edit, but I'll look at the other related PR too
id: related | ||
attributes: | ||
label: Resources | ||
description: Please include the relative pull request(s) or issue(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Please include the relative pull request(s) or issue(s). | |
description: Please include the related pull request(s) or issue(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@benironside This was fixed in the streamlined version of the template form.
We updated the template form when we merged #4308, so we can close this PR. |
Resolves first attempt of #4229.
Preview: https://github.com/elastic/security-docs/blob/doc-template-new/.github/ISSUE_TEMPLATE/internal-documentation-request--elastic-employees-.yaml
(It's not a perfect representation but it gives an idea of what the form will actually look like.)