-
Notifications
You must be signed in to change notification settings - Fork 0
Add admin docs for the release notes section #36
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: Release notes | ||
| sidebar: | ||
| order: 3079900 | ||
| --- | ||
|
|
||
| import Screenshot from "@components/Screenshot.astro"; | ||
|
|
||
| RoQua wordt doorlopend verder ontwikkeld. Onder **Overig → Release notes** vind je een overzicht van wat er in RoQua is veranderd, en wanneer. | ||
|
|
||
| <Screenshot src="/screenshots/admin_release_notes_index.png" /> | ||
|
|
||
| Per maand zie je welke wijzigingen zijn doorgevoerd, met een korte samenvatting. Door op een titel te klikken lees je de volledige toelichting. Het overzicht is zichtbaar voor iedereen die toegang heeft tot het beheergedeelte van je organisatie. | ||
|
|
||
| Wijzigingen die alleen technisch van aard zijn (onderhoud, verbeteringen onder de motorkap) staan er niet tussen. Het overzicht gaat alleen over wat er voor jou en je collega's verandert. | ||
|
|
||
| ## Ontvangers releasecommunicatie | ||
|
|
||
| Naast het overzicht in de Admin versturen we releasecommunicatie ook per e-mail: een maandelijkse samenvatting van de wijzigingen, en aankondigingen vooraf bij grote veranderingen. | ||
|
|
||
| Met de knop "Ontvangers beheren" stel je in wie deze e-mails ontvangt. | ||
|
|
||
| :::note | ||
| Ontvangers toevoegen werkt al, zodat je dit vast kunt instellen. Het versturen van de e-mails zelf wordt nog gebouwd. | ||
| ::: | ||
|
|
||
| <Screenshot src="/screenshots/admin_release_notes_recipients.png" /> | ||
|
|
||
| Via "Ontvanger toevoegen" voeg je een e-mailadres toe. De naam is optioneel, en mag ook een functie- of afdelingsnaam zijn. Een gedeelde mailbox (bijvoorbeeld van functioneel beheer) werkt hier prima voor. Met de prullenbakknop verwijder je een ontvanger weer. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: Release notes | ||
| sidebar: | ||
| order: 3079900 | ||
| --- | ||
|
|
||
| import Screenshot from "@components/Screenshot.astro"; | ||
|
|
||
| RoQua is under continuous development. Under **Other → Release notes** you'll find an overview of what has changed in RoQua, and when. | ||
|
|
||
| <Screenshot src="/screenshots/admin_release_notes_index.png" /> | ||
|
|
||
| For each month you'll see which changes were made, with a short summary. Click a title to read the full explanation. The overview is visible to everyone with access to your organization's admin area. | ||
|
|
||
| Purely technical changes (maintenance, under-the-hood improvements) are not included. The overview only covers what changes for you and your colleagues. | ||
|
|
||
| ## Release communication recipients | ||
|
|
||
| Besides the overview in the Admin, we also send release communication by email: a monthly summary of changes, and advance announcements of major changes. | ||
|
|
||
| The "Manage recipients" button lets you configure who receives these emails. | ||
|
|
||
| :::note | ||
| Adding recipients already works, so you can set this up now. Sending the emails themselves is still being implemented. | ||
| ::: | ||
|
|
||
| <Screenshot src="/screenshots/admin_release_notes_recipients.png" /> | ||
|
|
||
| Use "Add recipient" to add an email address. The name is optional, and may also be a role or department name. A shared mailbox (for example of your application administrators) works well here. The trash button removes a recipient again. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align the email-delivery wording with the implementation status.
Both pages state that emails are sent now, then state that email sending is not implemented. Use future or planned wording in both pages.
src/content/docs/en/docs/admin/other/release_notes.mdx#L19-L24: change “we also send” to “we plan to send”.src/content/docs/docs/admin/other/release_notes.mdx#L19-L24: change “versturen we” to “willen we ... versturen”.📍 Affects 2 files
src/content/docs/en/docs/admin/other/release_notes.mdx#L19-L24(this comment)src/content/docs/docs/admin/other/release_notes.mdx#L19-L24🤖 Prompt for AI Agents