Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Added a quick blurb to let folks know where they can check pending maintenance updates #2115

Merged
merged 5 commits into from
Sep 5, 2023
Merged

Added a quick blurb to let folks know where they can check pending maintenance updates #2115

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c01615
Added a quick blurb to let folks know where they can check pending ma…
josh-martin-aiven Aug 28, 2023
b03586c
Update maintenance-window.rst
josh-martin-aiven Aug 28, 2023
4678b55
Merge branch 'main' into check-maintenance-updates-tip
josh-martin-aiven Aug 30, 2023
e000883
Update maintenance-window.rst
josh-martin-aiven Aug 31, 2023
bf359bf
Update maintenance-window.rst
josh-martin-aiven Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/platform/concepts/maintenance-window.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,12 @@ In case of **Apache Kafka®** and **OpenSearch®** the service DNS address resol
Maintenance updates
~~~~~~~~~~~~~~~~~~~

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.
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the active voice (vs the passive voice) whenever possible:
You can view maintenance updates pending for your service using the following:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doneso. :)


1. Service overview page in `the Aiven Console <https://console.aiven.io/>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually the most relevant is https://github.com/aiven/devportal/blob/main/CONTRIBUTING.rst :-)


2. ``avn service get`` command in `the Aiven CLI <https://docs.aiven.io/docs/tools/cli/service#avn-service-get>`_.

3. ``service`` endpoint in `the Aiven REST API <https://api.aiven.io/doc/#tag/Service/operation/ServiceGet>`_.