Added a quick blurb to let folks know where they can check pending maintenance updates #2115
Conversation
…intenance updates.
Fixed maintenance typo.
Deploying with
|
| Latest commit: |
bf359bf
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f369e441.devportal.pages.dev |
| Branch Preview URL: | https://check-maintenance-updates-ti.devportal.pages.dev |
| Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. | ||
|
|
||
| Pending maintenance updates can be viewed in three places. |
There was a problem hiding this comment.
Please use the active voice (vs the passive voice) whenever possible:
You can view maintenance updates pending for your service using the following:
There was a problem hiding this comment.
Doneso. :)
| Pending maintenance updates can be viewed in three places. | ||
|
|
||
| 1. Service overview page in `the Aiven Console <https://console.aiven.io/>`_. |
There was a problem hiding this comment.
Please
- Rephrase to
Service's **Overview** page in `Aiven Console <https://console.aiven.io/>`_(GUI items always within**) - Use the unordered list (bullets) (the order of the items in the list is not significant).
- Remove the full stops at the ends of all three list items (the list items are not full sentences).
There was a problem hiding this comment.
Also done.
Also, I finally found the style guide. I'll make sure to review this for future docs updates. If this isn't the right style guide, lemme know. :)
https://aiven.slab.com/posts/style-guide-resources-for-editors-dag2nrwl
There was a problem hiding this comment.
Actually the most relevant is https://github.com/aiven/devportal/blob/main/CONTRIBUTING.rst :-)
Reworded addition to use active voice. put emphasis on overview. changed numbered list to bullet list.
| Security updates, platform updates that affect reliability or stability of the service nodes, and quarterly patch updates are always mandatory. Other updates are initially optional. Advance notice is given for all updates. After optional updates have been available for six months, they become mandatory and are applied on the next week's maintenance window at the earliest. This means you have at least 7 days advance notice with exception of critical security updates. These critical updates are applied in the maintenance window of the current week. During service upgrades, maintenance updates are automatically applied and do not require any action from you. | ||
|
|
||
| You can view pending maintenance updates in three places. |
There was a problem hiding this comment.
Please rephrase to "You can view maintenance updates pending for your service using the following:".
A command or an API endpoint is not a place :-)
There was a problem hiding this comment.
Got it. Just updated the wording to match latest suggestions. Let me know if there's anything else you'd like to adjust, discuss. :)
| You can view pending maintenance updates in three places. | ||
|
|
||
| - Service **overview** page in `the Aiven Console <https://console.aiven.io/>`_ |
There was a problem hiding this comment.
Please use Service's **Overview** page in `Aiven Console <https://console.aiven.io/>`_
Updated wording of initial sentence on bottom section. Used possessive form for for service's overview page. Removed the word "the" in hyperlinks.
What changed, and why it matters
After a recent case with a customer, I noticed that it would be helpful to include some links in our documentation on maintenance updates. These links show customers where they can check their service for pending maintenance updates.
I think it's important to have something like this in the maintenance docs, as it is not readily apparent or searchable how to get this information from a customer perspective.
I tried to keep this update concise, and focused on directing customers to existing documentation on APIs as opposed to putting direct usage info on this doc.
Let me know your thoughts on this addition. I'm happy to discuss any and all feedback. :)
Reference links
Support task Jira:
https://aiven.atlassian.net/browse/SUP-717
Internal case study:
https://aiven.slab.com/posts/where-can-customers-check-for-pending-maintenance-updates-00047810-j9zh17em