Docs feedback
See what readers said about the documentation and what they searched for without finding it, and send it to Stackship.
Requires: kernel/docsFeedback/export
Every documentation page in the portal ends with Did this help?, and every documentation search a reader submits (Enter in the header search) that finds nothing is counted. Both are kept on this platform, so you and Stackship can see what the documentation is missing, even on an installation without internet access. The platform never sends them anywhere: sending them to Stackship is something you do by hand.
What is kept
| Kept | Not kept |
|---|---|
| The page, its language and module version, and the answer (yes or no) | Who answered: no name, e-mail address or user id |
| An optional comment of at most 500 characters | Anything about the reader's browser or network |
| A search submitted with Enter that found nothing at all (no page, resource or documentation), how often, and on which days first and last | Who searched |
| The platform version, and the day (not the time) of each answer |
Each person has one answer per page: answering again replaces the first answer. To make that possible the platform keeps a keyed hash of the person and the page, which is never shown or exported. Its key is derived from the platform's data-encryption key, which is kept in a Kubernetes Secret and not in the database, so the database or a backup of it alone cannot tie an answer to a person.
Comments are free text. The portal asks readers not to write personal information, but read them before you send the export on.
Feedback is deleted 365 days after it was last given. The platform keeps at most 10,000 answers and 2,000 different searches; once full, it refuses new ones and keeps what it has, so no one can push out other people's feedback. Each person can send at most 100 answers and 100 searches a day.
See the feedback
Go to Admin > Docs feedback, at https://portal.example.com/admin/docs-feedback. The page shows how many answers were helpful or not, how many had a comment, and how many searches found nothing; the pages people found least helpful; and the searches that found nothing, most frequent first.
Send it to Stackship
- On Docs feedback, select Download JSON. Download CSV gives the same content as a table, if you want to read it in a spreadsheet first. The file carries the platform version and the time it was exported.
- Read the comments and the search words in the file, and remove anything you do not want to share. Both are free text your users typed, and may mention names, resources or internal details.
- Send the file to your Stackship contact, or attach it to a support case.
The platform does not upload anything, and nothing changes on the platform when you download.
Who can do this
Downloading the export needs kernel/docsFeedback/export at the platform root. Platform Owner
and Platform Contributor hold it; Platform Reader does not. Answering Did this help? needs
no permission: any signed-in user can do it, within the daily limits above and a limited number
of times per ten minutes.