This repository was archived by the owner on Jul 15, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Jul 15, 2026. It is now read-only.
Get documentation feedback from users #136
Description
A first idea from the Retro would be to try out some form of simple button to submit feedback about the documentation
Probably needs refinement
- Research the possibility of such a feature in our current setup
- Submit general feedback or per page?
- Where are the submitted feedbacks send to? How to read/address them?
Activity
xeniape commentedon Nov 21, 2025
Saw this feedback form in the OPA documentation, which looked nice and simple. Posting for reference later.
[-]Explore possibilities to get documentation feedback from users[/-][+]Get documentation feedback from users[/+]xeniape commentedon Apr 7, 2026
Refinement
Frontend
The common approach amongst Antora users seems to be to add a feedback submission form themselves as Antora does not provide anything like that. I tried out a simple prototype to test it out here: #147 and here stackabletech/documentation#833
Some screenshots of the prototype:
Backend
Didn't find a really good already existing solution for the backend to send the feedback submission to, but also didn't look too much into it to prioritize reusing things we already currently have for now or to have a discussion if someone can recommend something they know.
Possible solutions:
The Netlify Forms solutions might also be a good first try to get a feel for the feedback submission frequency and if it helps us improve the docs etc. Maybe, depending on the feedback frequency, this solution might also be enough for the beginning.
This is how the current prototype information would appear in Netlify Forms:
There is also the option of sending E-Mail / Slack notifications on submissions.
Regarding the Netlify Pricing: Not exactly sure how much the cost would be in Netlify, the docs say:
Was hard to find any information in Netlify itself where this limit is, but https://formgrid.dev/blog/netlify-forms-is-getting-expensive-here-are-the-best-alternatives-in-2026 mentions it being 100 form submissions per month. Which is not much in the long run but maybe for testing purposes it's okay. I'm not sure about the automatic upgrade though and what that would mean for pricing / the account.
Actually through the article above I stumbled upon https://github.com/allenarduino/formgrid while writing. Maybe that's something to explore for the implementation as a backend.
Also I'm not sure which submissions really count towards the limit for pricing. Because there are verified submissions and spam submissions. The prototype from this refinement also shows the use of a honeypot field for spam prevention.
The prototype also does not include sanitization. According to https://docs.netlify.com/manage/forms/submissions/#automatic-sanitization it should be included, but when testing it, it didn't seem so. However, that might be because, for the submission itself the prototype does not use Netlify automatic detection of fields, because the selection of the Yes/No buttons required a customized request. But a proper implementation could be looked into during the actual implementation.
Summary
The addition of a submission form itself should be fairly easy and was already tried out during the research as a prototype. The next thing would be deciding on a proper backend to send the submissions to, if that's either something small/simple for a try-out phase first like Netlify Forms, a proper backend already existing somewhere (any suggestions?), or implementing something ourselves.