From 6b7957a201313a485d98fb6acef6a563ad67e2b8 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Mon, 8 Jan 2024 13:52:07 +0100 Subject: [PATCH 01/10] New doc for Pro Platoform --- _toc.yml | 1 + docs/platform/howto/pro-platform.rst | 34 ++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 docs/platform/howto/pro-platform.rst diff --git a/_toc.yml b/_toc.yml index 8e64b7e56..c41559bf0 100644 --- a/_toc.yml +++ b/_toc.yml @@ -18,6 +18,7 @@ entries: - file: docs/platform/howto/billing-google-cloud-platform-marketplace-subscription title: Set up Google Cloud Marketplace subscriptions - file: docs/tools/aiven-console + - file: docs/platform/howto/pro-platform - file: docs/platform/concepts/beta_services - file: docs/platform/howto/feature-preview diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst new file mode 100644 index 000000000..d5c130cf2 --- /dev/null +++ b/docs/platform/howto/pro-platform.rst @@ -0,0 +1,34 @@ +Pro Platform +============= + +Pro Platform gives enterprise organizations added capabilities for implementing security, resilience, reliability, and cost-efficiency strategies for their data infrastructure. Pro Platform features are available across disaster recovery, security and compliance, advanced networking, and user lifecycle management. + +To use Pro features, enable Pro Platform for your organization. + + +Enable Pro Platform for an organization +---------------------------------------- + +#. Click the user information icon and select **Admin**. + +#. Click **Pro Platform**. + +#. Select a billing group for the Pro Platform charges. + +#. Click **Enable Pro Platform**. + + +Disable Pro Platform +--------------------- + +To disable Pro Platform for an organization, you should first disable any Pro features being used in your services. + +#. Click the user information icon and select **Admin**. + +#. Click **Pro Platform**. + +#. Click **Disable Pro Platform**. + +#. To confirm, click **Disable Pro Platform**. + +You can enable Pro Platform again at any time. From a120d039526d72e89fd3ac4cb149010e4d7e3f64 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 12 Jan 2024 09:58:47 +0100 Subject: [PATCH 02/10] Add template annotation for pro features --- CONTRIBUTING.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f3146d435..2134f3587 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -270,3 +270,14 @@ For features that are in the early availability stage and can be enabled in the .. important:: {feature name} is an :doc:`early availability feature `. To use it, :doc:`enable the feature preview ` in your user profile. + + +Pro Platform feature note template +''''''''''''''''''''''''''''''''''' + +For features that are only available on the Pro Platform, add the following admonition directly under the article title: + +.. code:: + + .. important:: + {feature name} is available on the :doc:`Pro Platform `. From bf739a1598e2c2b66ef58681bf49490ee0961f3b Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 12 Jan 2024 10:44:03 +0100 Subject: [PATCH 03/10] TOC --- _toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_toc.yml b/_toc.yml index c41559bf0..52d0f6c2b 100644 --- a/_toc.yml +++ b/_toc.yml @@ -18,13 +18,13 @@ entries: - file: docs/platform/howto/billing-google-cloud-platform-marketplace-subscription title: Set up Google Cloud Marketplace subscriptions - file: docs/tools/aiven-console - - file: docs/platform/howto/pro-platform - file: docs/platform/concepts/beta_services - file: docs/platform/howto/feature-preview # -------- ORGANIZATIONS, UNITS, PROJECTS -------- - file: docs/platform/howto/list-account entries: + - file: docs/platform/howto/pro-platform - file: docs/platform/concepts/projects_accounts_access - file: docs/tools/aiven-console/howto/create-accounts - file: docs/platform/howto/manage-organizations From 0429da68a7535890bb02b3b7c7268858ed65a987 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 12 Jan 2024 10:57:56 +0100 Subject: [PATCH 04/10] Update instructions and TOC --- _toc.yml | 2 +- docs/platform/howto/pro-platform.rst | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/_toc.yml b/_toc.yml index 52d0f6c2b..c41559bf0 100644 --- a/_toc.yml +++ b/_toc.yml @@ -18,13 +18,13 @@ entries: - file: docs/platform/howto/billing-google-cloud-platform-marketplace-subscription title: Set up Google Cloud Marketplace subscriptions - file: docs/tools/aiven-console + - file: docs/platform/howto/pro-platform - file: docs/platform/concepts/beta_services - file: docs/platform/howto/feature-preview # -------- ORGANIZATIONS, UNITS, PROJECTS -------- - file: docs/platform/howto/list-account entries: - - file: docs/platform/howto/pro-platform - file: docs/platform/concepts/projects_accounts_access - file: docs/tools/aiven-console/howto/create-accounts - file: docs/platform/howto/manage-organizations diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index d5c130cf2..55566755b 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -6,10 +6,12 @@ Pro Platform gives enterprise organizations added capabilities for implementing To use Pro features, enable Pro Platform for your organization. -Enable Pro Platform for an organization ----------------------------------------- +Enable Pro Platform +-------------------- -#. Click the user information icon and select **Admin**. +To enable Pro Platform for an organization: + +#. In the organization, click **Admin**. #. Click **Pro Platform**. @@ -23,11 +25,11 @@ Disable Pro Platform To disable Pro Platform for an organization, you should first disable any Pro features being used in your services. -#. Click the user information icon and select **Admin**. +#. In the organization, click **Admin**. #. Click **Pro Platform**. -#. Click **Disable Pro Platform**. +#. Open the actions mentu and select **Disable Pro Platform**. #. To confirm, click **Disable Pro Platform**. From a0fb1d70a01266c818aea1d0f0ead4e7842845b6 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 12 Jan 2024 12:46:31 +0100 Subject: [PATCH 05/10] Fix typo and capitalization --- .github/vale/styles/Aiven/capitalization_headings.yml | 1 + docs/platform/howto/pro-platform.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/vale/styles/Aiven/capitalization_headings.yml b/.github/vale/styles/Aiven/capitalization_headings.yml index 8fdf5d8f5..e57054578 100644 --- a/.github/vale/styles/Aiven/capitalization_headings.yml +++ b/.github/vale/styles/Aiven/capitalization_headings.yml @@ -110,6 +110,7 @@ exceptions: - Private Link - PrivateLink - Private Service Connect + - Pro Platform - Project - Prometheus - Provectus diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index 55566755b..2f6edaabe 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -29,7 +29,7 @@ To disable Pro Platform for an organization, you should first disable any Pro fe #. Click **Pro Platform**. -#. Open the actions mentu and select **Disable Pro Platform**. +#. Open the actions menu and select **Disable Pro Platform**. #. To confirm, click **Disable Pro Platform**. From 7208887230738735de2a7a6afcaf734b40c454b2 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 12 Jan 2024 14:21:07 +0100 Subject: [PATCH 06/10] address comments --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2134f3587..aecfda8ee 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -280,4 +280,4 @@ For features that are only available on the Pro Platform, add the following admo .. code:: .. important:: - {feature name} is available on the :doc:`Pro Platform `. + {feature name} is available on :doc:`Pro Platform `. From 018247905216886157e8e5e59a2ad11224592e0f Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Mon, 15 Jan 2024 12:50:37 +0100 Subject: [PATCH 07/10] Remove instructions --- CONTRIBUTING.rst | 2 +- docs/platform/howto/pro-platform.rst | 31 +--------------------------- 2 files changed, 2 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index aecfda8ee..f03a70195 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -275,7 +275,7 @@ For features that are in the early availability stage and can be enabled in the Pro Platform feature note template ''''''''''''''''''''''''''''''''''' -For features that are only available on the Pro Platform, add the following admonition directly under the article title: +For features that are only available to customers that have Pro Platform enabled, add the following admonition directly under the article title: .. code:: diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index 2f6edaabe..a622f6940 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -3,34 +3,5 @@ Pro Platform Pro Platform gives enterprise organizations added capabilities for implementing security, resilience, reliability, and cost-efficiency strategies for their data infrastructure. Pro Platform features are available across disaster recovery, security and compliance, advanced networking, and user lifecycle management. -To use Pro features, enable Pro Platform for your organization. +To enable Pro Platform for your organization and use Pro features, contact the sales team at sales@Aiven.io. - -Enable Pro Platform --------------------- - -To enable Pro Platform for an organization: - -#. In the organization, click **Admin**. - -#. Click **Pro Platform**. - -#. Select a billing group for the Pro Platform charges. - -#. Click **Enable Pro Platform**. - - -Disable Pro Platform ---------------------- - -To disable Pro Platform for an organization, you should first disable any Pro features being used in your services. - -#. In the organization, click **Admin**. - -#. Click **Pro Platform**. - -#. Open the actions menu and select **Disable Pro Platform**. - -#. To confirm, click **Disable Pro Platform**. - -You can enable Pro Platform again at any time. From 68b5d21c3eed53615134d9ecc1a901b53f63c0eb Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Wed, 17 Jan 2024 11:35:01 +0100 Subject: [PATCH 08/10] Add super admin requirement --- docs/platform/howto/pro-platform.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index a622f6940..f625210cd 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -3,5 +3,5 @@ Pro Platform Pro Platform gives enterprise organizations added capabilities for implementing security, resilience, reliability, and cost-efficiency strategies for their data infrastructure. Pro Platform features are available across disaster recovery, security and compliance, advanced networking, and user lifecycle management. -To enable Pro Platform for your organization and use Pro features, contact the sales team at sales@Aiven.io. +To enable Pro Platform for your organization and use Pro features, contact the sales team at sales@Aiven.io. You must be a super admin to request this. From 39e2bb44a0ac845175ed740f7f4619b744b2ff90 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 19 Jan 2024 10:08:37 +0100 Subject: [PATCH 09/10] Add EA note --- docs/platform/howto/pro-platform.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index f625210cd..48db16b5e 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -1,6 +1,9 @@ Pro Platform ============= + .. important:: + Pro Platform is in :doc:`early availability `. + Pro Platform gives enterprise organizations added capabilities for implementing security, resilience, reliability, and cost-efficiency strategies for their data infrastructure. Pro Platform features are available across disaster recovery, security and compliance, advanced networking, and user lifecycle management. To enable Pro Platform for your organization and use Pro features, contact the sales team at sales@Aiven.io. You must be a super admin to request this. From 8acbafc189ad42a872cde205457cd816ad57e101 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 19 Jan 2024 10:31:16 +0100 Subject: [PATCH 10/10] fix indent --- docs/platform/howto/pro-platform.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platform/howto/pro-platform.rst b/docs/platform/howto/pro-platform.rst index 48db16b5e..c6983ec47 100644 --- a/docs/platform/howto/pro-platform.rst +++ b/docs/platform/howto/pro-platform.rst @@ -1,8 +1,8 @@ Pro Platform ============= - .. important:: - Pro Platform is in :doc:`early availability `. +.. important:: + Pro Platform is in :doc:`early availability `. Pro Platform gives enterprise organizations added capabilities for implementing security, resilience, reliability, and cost-efficiency strategies for their data infrastructure. Pro Platform features are available across disaster recovery, security and compliance, advanced networking, and user lifecycle management.