Skip to content

Create issue template for website problems #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zzap merged 3 commits into from
May 23, 2026
+55 −1
Merged

Create issue template for website problems #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb8d761
Create issue template for website problems
zzap May 23, 2026
179c6c9
Add a link to reporting an issue.
zzap May 23, 2026
8f7da8e
Making a stupid change to check the sign off.
zzap May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/website-issue.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Report issues from the docs.fair.pm website

name: Website problem
description: Report a problem with the FAIR documentation website
title: "[Website]: "
labels: ["website", "documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a problem with the FAIR docs website.

- type: dropdown
id: problem_type
attributes:
label: What kind of problem is this?
options:
- Accessibility issue
- Broken link
- Incorrect or outdated content
- Missing information
- Website bug
- Search/navigation problem
- Other
validations:
required: true

- type: input
id: page_url
attributes:
label: Page URL
description: Paste the page where you noticed the problem.
placeholder: https://docs.fair.pm/...
validations:
required: false

- type: textarea
id: description
attributes:
label: What happened?
description: Describe the issue or inquiry.
validations:
required: true

- type: textarea
id: expected
attributes:
label: What did you expect?
validations:
required: false
6 changes: 5 additions & 1 deletion docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ const config = {
navbar: {
title: 'FAIR Documentation',
// logo: {
// alt: 'My Site Logo',
// alt: 'FAIR Logo',
// src: 'img/logo.svg',
// },
items: [
Expand Down Expand Up @@ -119,6 +119,10 @@ const config = {
label: 'About this documentation',
to: 'about',
},
{
label: 'Found an issue? Report it here',
href: 'https://github.com/fairpm/docs/issues/new?template=website-issue.yml',
},
{
label: 'Docs GitHub repo',
href: 'https://github.com/fairpm/docs',
Expand Down
Loading