Skip to content

Commit 355784b

Browse files
authored
[admin] Update issue templates and in-page feedback controls (#319)
* Update issue templates and in-page feedback controls * Fix ms.devlang value * Order issue templates
1 parent 78e0ebb commit 355784b

File tree

4 files changed

+104
-3
lines changed

4 files changed

+104
-3
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation issue
3+
about: Tell us about a problem in the documentation
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Article URL**
11+
On what page did you find the problem?
12+
13+
**Describe the problem**
14+
A clear and concise description of what is incorrect, unclear, or missing in the document.
15+
16+
**Screenshots**
17+
If applicable, add screenshots to help explain your problem.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Sample request
3+
about: Which features would you like to see more of?
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe your scenario**
11+
What is the problem to solve?
12+
13+
**Which APIs or Excel features?**
14+
What should be showcased in the sample? Are there Excel features that need samples to better understand how to use them in scripts?
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: "📄 Feedback control template"
2+
title: "Feedback"
3+
description: >-
4+
⛔ This template is intended for use by the feedback control on the bottom of every page on the
5+
live site. If you aren't using the feedback control, choose one of the other templates.⛔
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "## 🎁Enter your feedback🎁"
10+
- type: markdown
11+
attributes:
12+
value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue.
13+
- type: dropdown
14+
id: issue-type
15+
attributes:
16+
label: Type of issue
17+
options:
18+
- Typo
19+
- Code doesn't work
20+
- Missing information
21+
- Outdated article
22+
- Other (describe below)
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: userfeedback
27+
validations:
28+
required: true
29+
attributes:
30+
label: Feedback
31+
description: >-
32+
If possible, please provide extended details that will add context and help the team update
33+
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
34+
For technical or factual errors, please include code snippets and output to show how the
35+
documentation is incorrect.
36+
- type: markdown
37+
attributes:
38+
value: "## 🚧 Article information 🚧"
39+
- type: markdown
40+
attributes:
41+
value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*."
42+
- type: input
43+
id: pageUrl
44+
validations:
45+
required: true
46+
attributes:
47+
label: Page URL
48+
- type: input
49+
id: contentSourceUrl
50+
validations:
51+
required: true
52+
attributes:
53+
label: Content source URL
54+
- type: input
55+
id: author
56+
validations:
57+
required: true
58+
attributes:
59+
label: Author
60+
description: GitHub Id of the author
61+
- type: input
62+
id: documentVersionIndependentId
63+
validations:
64+
required: true
65+
attributes:
66+
label: Document Id

docs/docfx.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,26 @@
109109
"ms.subservice": "scripts",
110110
"ms.service": "excel",
111111
"ms.topic": "reference",
112+
"open_source_feedback_contributorGuideUrl": "https://github.com/OfficeDev/office-scripts-docs-reference/blob/main/Contributing.md",
113+
"open_source_feedback_issueTitle": "",
114+
"open_source_feedback_issueUrl": "https://github.com/OfficeDev/office-scripts-docs-reference/issues/new?template=3-customer-feedback.yml",
115+
"open_source_feedback_productName": "Office Scripts",
112116
"titleSuffix": "Office Scripts",
113-
"ms.devlang": "JavaScript",
117+
"ms.devlang": "typescript",
114118
"product": [
115119
"office 365"
116120
],
117121
"products": [
118122
"https://authoring-docs-microsoft.poolparty.biz/devrel/60932d05-feee-4685-a73b-595e25dd9318",
119123
"https://authoring-docs-microsoft.poolparty.biz/devrel/6ab06385-661e-4214-8870-bbe4071c960d"
120124
],
121-
"feedback_system": "GitHub",
125+
"feedback_system": "OpenSource",
122126
"feedback_github_repo": "OfficeDev/office-scripts-docs-reference",
123127
"feedback_product_url": "/answers/tags/321/office-development"
124128
},
125129
"fileMetadata": {
126130
"feedback_system": {
127-
"docs-ref-conceptual/**/*": "GitHub"
131+
"docs-ref-conceptual/**/*": "OpenSource"
128132
},
129133
"feedback_github_repo": {
130134
"docs-ref-conceptual/**/*": "OfficeDev/office-scripts-docs-reference"

0 commit comments

Comments
 (0)