Skip to content

Commit

Permalink
Adds new github issue template (#4262)
Browse files Browse the repository at this point in the history
* Adds new issue template

* updates .yaml template

* removes newlines

* fixes spacing error

* minor updates

* minor update

* minor edits

* incorporates feedback

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml

Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>

---------

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Co-authored-by: Janeen Mikell Roberts <57149392+jmikell821@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 30, 2023
1 parent e3eb32a commit f14246c
Showing 1 changed file with 97 additions and 0 deletions.
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/ui-copy-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: "UI copy request"
description: Submit a UI copy-related request to the security documentation team.
title: "[UI copy]: "
labels: "ui-copy"
body:
- type: markdown
attributes:
value: |
Hello! Use this form to submit a UI-related issue to the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team.
- type: textarea
id: description
attributes:
label: Description
description: Summarize your request here. What is the work and how can we help? Do we need to write new copy, or edit existing copy? Feel free to include screenshots.
placeholder: |
What: We're introducing new feature A.
When: This feature will launch at the completion of project B.
Why: This feature will make X, Y, and Z easier for the user.
validations:
required: true
- type: textarea
id: related
attributes:
label: Related links / assets
description: Where can the documentation team learn more about this feature?
value: |
Please include each of the following, if applicable:
Figma link(s):
Github epic link(s):
Github issue link(s):
How to find the text in a production environment:
Testing environment information:
NOTE: To keep sensitive information such as credentials secure, do not include it in this form.
validations:
required: true
- type: dropdown
id: doc-set
attributes:
label: Which documentation set does this change impact?
description: ESS, serverless, or both?
options:
- ESS and serverless
- ESS only
- Serverless only
- Unknown / Not applicable
default: 0
validations:
required: true
- type: textarea
id: doc-set-differences
attributes:
label: Feature differences
description: If you selected both ESS and serverless above, please describe how, if at all, the feature differs in each deployment method.
placeholder: The feature is identical in ESS and serverless.
validations:
required: true
- type: textarea
id: software-version
attributes:
label: Software version
description: Is this work targeted for a particular release version? If so, which one?
placeholder: |
For example:
"8.13.0";
"This feature has been in production since 8.11.0";
"N/A"
validations:
required: true
- type: textarea
id: collaborators
attributes:
label: Collaborators
description: Please include contact information for the responsible product manager, designer, and developer.
value: |
PM:
Designer:
Developer:
Others (if applicable):
validations:
required: true
- type: textarea
id: timeline
attributes:
label: Timeline / deliverables
description: When would it be ideal for for us to complete the request? What deliverables do you need, and when? If applicable, how do the release timelines for this feature differ between serverless / stateful?
placeholder: |
For example:
We need a final draft of the new UI copy no later than December 5, ideally by December 1. No differences between serverless/ESS.
This is an urgent request, it would be great to have updated copy for A and B ASAP, since the original copy is already in production. No differences between serverless/ESS.
validations:
required: true
- type: markdown
attributes:
value: |
Thanks for submitting this issue! For urgent issues, we encourage you to send a message in the [#security-docs](https://elastic.slack.com/archives/C013W8WME2Z) Slack channel.

0 comments on commit f14246c

Please sign in to comment.