Skip to content

Commit e5a5e92

Browse files
authored
Merge pull request #26 from fairpm/website-issue-template
Create issue template for website problems
2 parents dac8e17 + 8f7da8e commit e5a5e92

2 files changed

Lines changed: 55 additions & 1 deletion

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Report issues from the docs.fair.pm website
2+
3+
name: Website problem
4+
description: Report a problem with the FAIR documentation website
5+
title: "[Website]: "
6+
labels: ["website", "documentation", "triage"]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for reporting a problem with the FAIR docs website.
12+
13+
- type: dropdown
14+
id: problem_type
15+
attributes:
16+
label: What kind of problem is this?
17+
options:
18+
- Accessibility issue
19+
- Broken link
20+
- Incorrect or outdated content
21+
- Missing information
22+
- Website bug
23+
- Search/navigation problem
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: page_url
30+
attributes:
31+
label: Page URL
32+
description: Paste the page where you noticed the problem.
33+
placeholder: https://docs.fair.pm/...
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: description
39+
attributes:
40+
label: What happened?
41+
description: Describe the issue or inquiry.
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: expected
47+
attributes:
48+
label: What did you expect?
49+
validations:
50+
required: false

docs/docusaurus.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const config = {
7777
navbar: {
7878
title: 'FAIR Documentation',
7979
// logo: {
80-
// alt: 'My Site Logo',
80+
// alt: 'FAIR Logo',
8181
// src: 'img/logo.svg',
8282
// },
8383
items: [
@@ -119,6 +119,10 @@ const config = {
119119
label: 'About this documentation',
120120
to: 'about',
121121
},
122+
{
123+
label: 'Found an issue? Report it here',
124+
href: 'https://github.com/fairpm/docs/issues/new?template=website-issue.yml',
125+
},
122126
{
123127
label: 'Docs GitHub repo',
124128
href: 'https://github.com/fairpm/docs',

0 commit comments

Comments
 (0)