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.

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

Documentation suggestion box or equivalent #2005

Open
jfrome1 opened this issue Jan 30, 2021 · 0 comments
Open

Documentation suggestion box or equivalent #2005

jfrome1 opened this issue Jan 30, 2021 · 0 comments
Labels
new feature A new thing that doesn't exist yet

Comments

@jfrome1
Copy link

jfrome1 commented Jan 30, 2021

Is your feature request related to a problem? Please describe.
On the documentation pages at https://janeway.readthedocs.io, there is no obvious way to tell the Janeway team that you can't find the answer to a question you have, so they do not get feedback on the type of documentation improvements that are needed. I couldn't find out how to change the text on the 'Decline to Review' page, e.g., and I don't know whether it's possible to do so or not.

Describe the solution you'd like
Add a prominent link to the left sidebar of the documentation site with something like "Do you have a question that is not answered here? Tell us so we can improve the documentation."

Clicking that link will take users to a form that has four parts.

  1. The user can enter the question they are trying to answer.

  2. The user is prompted to enter the search terms they used to try to find the answer in the current documentation. This has the added benefit of prompting users to actually search the existing documentation before bothering the dev team. Also, if the user doesn't enter any search terms, the page can prompt them to try searching before sending the question via the form.

  3. The user can be given links to the Janeway support forum and GitHub pages with an explanation of when they should look at these resources rather than the documentation.

  4. The form should give the user the option to put in their email and submit their question and get notified when the information is uploaded to the documentation.

Alternately, the form could include just 2 and 3 above, and the user could be prompted to submit their questions through existing resources. The downside is that (I think) they need to make accounts at those places to submit their questions, so feedback will be reduced.

Describe alternatives you've considered
Leave as is and reduce the ability of users to let you know what the documentation is not explaining to them.

@jfrome1 jfrome1 added the new feature A new thing that doesn't exist yet label Jan 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature A new thing that doesn't exist yet
Projects
None yet
Development

No branches or pull requests

1 participant