Skip to content
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

[ENH] Document how to give feedback on documentation and add issue template #132

Merged
merged 3 commits into from
Nov 20, 2023
Merged

[ENH] Document how to give feedback on documentation and add issue template #132

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
51a2a10
add issue template for documentation request
alyssadai Nov 20, 2023
49f3406
reorganize Getting Help page and explain how to give docs feedback
alyssadai Nov 20, 2023
3d26ecc
Update docs/getting_help.md
alyssadai Nov 20, 2023
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
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Documentation request

description: Suggest a new documentation topic or improvement to existing documentation.

body:
- type: textarea
attributes:
label: Description
description: What was unclear or what you would like to see documented?
validations:
required: true
- type: textarea
attributes:
label: Relevant documentation pages
description: Please link any existing documentation pages relevant to your request.
validations:
required: false
- type: textarea
attributes:
label: Additional details
description: |
Any other details you think would be helpful?

Specific use cases, examples, etc.
validations:
required: false
8 changes: 7 additions & 1 deletion docs/getting_help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Getting Help

## Report a bug or request a feature
For a bug or feature request, feel free to open an issue in the repository for the relevant tool in the [Neurobagel GitHub organization](https://github.com/neurobagel).

If you are using one of our web tools ([https://query.neurobagel.org](https://query.neurobagel.org) or [https://query.neurobagel.org](https://annotate.neurobagel.org)), you can also submit suggestions and bugs using the feedback widget directly on the site.
If you are using one of our web tools ([https://annotate.neurobagel.org](https://annotate.neurobagel.org) or [https://query.neurobagel.org](https://query.neurobagel.org), you can also submit suggestions and bugs using the feedback widget directly on the site.

## Documentation feedback
We are always looking to improve our user documentation.
To request a change or addition to existing documentation, please [open an issue in the `neurobagel/documentation` repo](https://github.com/neurobagel/documentation/issues).
alyssadai marked this conversation as resolved.
Show resolved Hide resolved

## General questions
For general questions about Neurobagel, please open an issue on Neurostars with the `neurobagel` tag: [https://neurostars.org/tag/neurobagel](https://neurostars.org/tag/neurobagel).