-
Notifications
You must be signed in to change notification settings - Fork 162
Creates UI copy request template #1244
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
98c87ae
create UI copy request template
benironside 9171fcb
minor edit
benironside d215b6f
Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml
benironside 407c994
Update .github/ISSUE_TEMPLATE/ui-copy-request.yaml
benironside 3dc4e50
Merge branch 'main' into create-UI-copy-request-template
benironside 118b08f
Merge branch 'main' into create-UI-copy-request-template
benironside File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
name: "UI copy request" | ||
description: Submit a UI copy-related request to the documentation team. | ||
title: "[UI copy]: " | ||
labels: "ui-copy" | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Hello! Use this form to submit a UI copy related request to Elastic's documentation team. You should also directly contact the specific writer or docs team that's responsibile for the applicable part of the product, especially for time-sensitive requests. | ||
> [!WARNING] | ||
> THIS IS A PUBLIC REPO. DO NOT INCLUDE SENSITIVE INFORMATION HERE. | ||
- 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. We need a writer to review the UI copy. | ||
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.19.0"; | ||
"This feature has been in production since 8.15.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! Remember to contact a writer directly or to send a message in the #docs Slack channel. | ||
benironside marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.