Add link to "create new issue" in this repo to the website footer

[melissawm]

🧰 Task

As discussed in the Documentation working group meeting on Nov 30, 2022.

[kandarpksk]

I believe that ways to create issues and for contributors to quickly make edits will be useful, but this is also a great opportunity to collect other types of feedback, say, helpfulness/quality ratings that will:

• Help us know how documentation is perceived overall (and help focus future efforts)
• Pages that are doing well (that can be prioritized to surface to users early)
• Areas of improvement

If we are able to collect feedback on the page itself (rather than require creation of an issue), it is likely to increase the amount of feedback we can get from users.

[Czaki]

If we are able to collect feedback on the page itself (rather than require creation of an issue), it is likely to increase the amount of feedback we can get from users.

It is possible. Services like sentry allow to do this and will remove barriers oh having github account.

[melissawm]

Here are a few screenshots on how other projects do this:

• GitHub docs

• hack programming language (Open Source project) On answering "thumbs down":

• NetGate/pfSense docs

• ReactJS docs

• Hypertables Feedback link leads to a new GitHub with a specific template

• MATLAB documentation

[melissawm]

We discussed this in the documentation working group meeting today. Here's a summary of ideas and thoughts that came up:

• Our readers who are already familiar with GitHub may be better equipped to open issues with feedback directly, while a larger audience that doesn't have a github account would like to have a text box embedded in the page itself.
• The stars rating seems less useful than the Thumbs up/Thumbs down + text feedback workflow.
• We should probably have a research plan or figure out which questions we want to ask and what insights we hope to get from this feedback before implementation.
• We probably want to also check how many people click the feedback tool but don't open issues/leave comments.
• For opening the issue, using the more advanced issue form (like Hypertables does) looks like a good way to get actionable feedback.

[Czaki]

There is also a requirement to have allocated time for reading user feedback, identifying documentation weak points, and translating it into a summary available to all developers.

[psobolewskiPhD]

Came across this today: https://giscus.app

A way to have dicussions/comments on pages that are GitHub discussions. Maybe moderately useful? requires GitHub account, so may be a barrier to entry, but sometimes you need some barriers...