Skip to content
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

Closed
wants to merge 8 commits into from
Closed

Update issue templates #4301

wants to merge 8 commits into from

Conversation

jmikell821
Copy link
Contributor

@jmikell821 jmikell821 commented Nov 20, 2023

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.)

@jmikell821 jmikell821 requested a review from a team as a code owner November 20, 2023 17:19
@jmikell821 jmikell821 marked this pull request as draft November 20, 2023 17:20
Copy link

Documentation previews:

This comment was marked as resolved.

@jmikell821 jmikell821 marked this pull request as ready for review November 20, 2023 18:46
@joepeeples
Copy link
Contributor

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.

@joepeeples
Copy link
Contributor

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?

Copy link
Contributor

@benironside benironside left a 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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: Please include the relative pull request(s) or issue(s).
description: Please include the related pull request(s) or issue(s).

Copy link
Contributor

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.

@joepeeples
Copy link
Contributor

We updated the template form when we merged #4308, so we can close this PR.

@joepeeples joepeeples closed this Nov 29, 2023
@joepeeples joepeeples deleted the doc-template-new branch November 29, 2023 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants