Skip to content

Commit abd3367

Browse files
authored
[DOCS-1323] Improvements for reporting an issue (#1264)
[DOCS-1323] Improvements for reporting an issue - Add praise template - Add feedback template - Update Hugo config to use the new templates when the user clicks Yes/No for 'Was this page helpful?' question (this is hard to test before we merge) - Don't change the behavior of the Report an issue link in page-meta-lastmod partial This change is difficult to test without merging. I'll fast-follow or revert if there are issues.
1 parent 00c0eb5 commit abd3367

4 files changed

Lines changed: 27 additions & 3 deletions

File tree

.github/ISSUE_TEMPLATE/feedback.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: feedback
3+
about: Template for providing feedback about unhelpful content
4+
title: Feedback or issue summary
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
W&B employees: Please file a doc JIRA instead, using this template: https://wandb.atlassian.net/secure/CreateIssueDetails!init.jspa?priority=3&pid=10026&issuetype=10047
11+
12+
We're sorry you did not find this content helpful. Please give us suggestions for improvement. If relevant, include links, screenshots, or additional details.

.github/ISSUE_TEMPLATE/general_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ assignees: ''
77

88
---
99

10-
W&B employees: Please file a doc JIRA instead, using this template: https://wandb.atlassian.net/secure/CreateIssueDetails!init.jspa?priority=3&pid=10026&issuetype=10047)
10+
W&B employees: Please file a doc JIRA instead, using this template: https://wandb.atlassian.net/secure/CreateIssueDetails!init.jspa?priority=3&pid=10026&issuetype=10047
1111

1212
Describe the issue or feedback, providing links, screenshots, or additional details as appropriate.

.github/ISSUE_TEMPLATE/praise.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: praise
3+
about: Template for providing feedback about helpful content
4+
title: Feedback
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
W&B employees: Please file a doc JIRA instead, using this template: https://wandb.atlassian.net/secure/CreateIssueDetails!init.jspa?priority=3&pid=10026&issuetype=10047
11+
12+
We're glad you found this content helpful. If you have additional info, please let us know.

hugo.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ params:
166166
enable: true
167167
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
168168
'yes': >-
169-
Glad to hear it! Please <a href="https://github.com/wandb/docs/issues/new">tell us how we can improve</a>.
169+
Glad to hear it! If you have further feedback, please <a href="https://github.com/wandb/docs/issues/new?template=praise.md">let us knowe</a>.
170170
'no': >-
171-
Sorry to hear that. Please <a href="https://github.com/wandb/docs/issues/new">tell us how we can improve</a>.
171+
Sorry to hear that. Please <a href="https://github.com/wandb/docs/issues/new?template=feedback.md">tell us how we can improve</a>.
172172
# Adds a reading time to the top of each doc.
173173
# If you want this feature, but occasionally need to remove the Reading time from a single page,
174174
# add "hide_readingtime: true" to the page's front matter

0 commit comments

Comments
 (0)