Skip to content

Commit b4f85ae

Browse files
benironsideflorent-leborgnejmikell821
authored
Creates UI copy request template (#1244)
Creates a UI copy request template for the docs-content repo. To preview the template, go to the code tab in this repo, switch to the `create-UI-copy-request-template` branch, then navigate to https://github.com/elastic/docs-content/blob/create-UI-copy-request-template/.github/ISSUE_TEMPLATE/ui-copy-request.yaml --------- Co-authored-by: florent-leborgne <[email protected]> Co-authored-by: Janeen Mikell Roberts <[email protected]>
1 parent 8e066c7 commit b4f85ae

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: "UI copy request"
2+
description: Submit a UI copy-related request to the documentation team.
3+
title: "[UI copy]: "
4+
labels: "ui-copy"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
> [!WARNING]
11+
> THIS IS A PUBLIC REPO. DO NOT INCLUDE SENSITIVE INFORMATION HERE.
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
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.
17+
placeholder: |
18+
What: We're introducing new feature A. We need a writer to review the UI copy.
19+
When: This feature will launch at the completion of project B.
20+
Why: This feature will make X, Y, and Z easier for the user.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: related
25+
attributes:
26+
label: Related links / assets
27+
description: Where can the documentation team learn more about this feature?
28+
value: |
29+
Please include each of the following, if applicable:
30+
Figma link(s):
31+
Github epic link(s):
32+
Github issue link(s):
33+
How to find the text in a production environment:
34+
Testing environment information:
35+
NOTE: To keep sensitive information such as credentials secure, do not include it in this form.
36+
validations:
37+
required: true
38+
- type: dropdown
39+
id: product-area
40+
attributes:
41+
label: Which product area does this mainly concern?
42+
options:
43+
- Cloud UI
44+
- Search solution
45+
- Observability solution
46+
- Security solution
47+
- Kibana Analytics (Discover, Dashboards...)
48+
- Kibana Management
49+
- Something else
50+
default: 0
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: collaborators
55+
attributes:
56+
label: Collaborators
57+
description: Please include contact information for the responsible product manager, designer, and developer.
58+
value: |
59+
PM:
60+
Designer:
61+
Developer:
62+
Others (if applicable):
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: timeline
67+
attributes:
68+
label: Timeline / deliverables
69+
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?
70+
placeholder: |
71+
For example:
72+
73+
We need a final draft of the new UI copy no later than December 5, ideally by December 1. No differences between serverless/ESS.
74+
75+
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.
76+
validations:
77+
required: true
78+
- type: markdown
79+
attributes:
80+
value: |
81+
Thanks for submitting this issue! We'll be in contact shortly.

0 commit comments

Comments
 (0)