You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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: doc-set
40
+
attributes:
41
+
label: Which documentation set does this change impact?
42
+
description: ESS, serverless, or both?
43
+
options:
44
+
- ESS and serverless
45
+
- ESS only
46
+
- Serverless only
47
+
- Unknown / Not applicable
48
+
default: 0
49
+
validations:
50
+
required: true
51
+
- type: textarea
52
+
id: doc-set-differences
53
+
attributes:
54
+
label: Feature differences
55
+
description: If you selected both ESS and serverless above, please describe how, if at all, the feature differs in each deployment method.
56
+
placeholder: The feature is identical in ESS and serverless.
57
+
validations:
58
+
required: true
59
+
- type: textarea
60
+
id: software-version
61
+
attributes:
62
+
label: Software version
63
+
description: Is this work targeted for a particular release version? If so, which one?
64
+
placeholder: |
65
+
For example:
66
+
"8.13.0";
67
+
"This feature has been in production since 8.11.0";
68
+
"N/A"
69
+
validations:
70
+
required: true
71
+
- type: textarea
72
+
id: collaborators
73
+
attributes:
74
+
label: Collaborators
75
+
description: Please include contact information for the responsible product manager, designer, and developer.
76
+
value: |
77
+
PM:
78
+
Designer:
79
+
Developer:
80
+
Others (if applicable):
81
+
validations:
82
+
required: true
83
+
- type: textarea
84
+
id: timeline
85
+
attributes:
86
+
label: Timeline / deliverables
87
+
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?
88
+
placeholder: |
89
+
For example:
90
+
91
+
We need a final draft of the new UI copy no later than December 5, ideally by December 1. No differences between serverless/ESS.
92
+
93
+
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.
94
+
validations:
95
+
required: true
96
+
- type: markdown
97
+
attributes:
98
+
value: |
99
+
Thanks for submitting this issue! For urgent issues, we encourage you to send a message in the #docs Slack channel.
0 commit comments