From a8098045a7f047ed343d2665306d6a84a1fd3731 Mon Sep 17 00:00:00 2001 From: Kyriakos Akriotis Date: Thu, 30 Nov 2023 12:20:52 +0100 Subject: [PATCH] - change typos in rst components --- doc/source/caf/adopt/application-migration.rst | 2 +- .../data-management-and-analytics-platform.rst | 2 +- doc/source/caf/adopt/rearchitect.rst | 5 ----- .../caf/govern-and-manage/change-management.rst | 2 +- .../caf/govern-and-manage/cost-management.rst | 2 +- .../caf/govern-and-manage/emergency-handling.rst | 2 +- doc/source/caf/index.rst | 1 + doc/source/caf/plan/cloud-adoption-dimensions.rst | 2 +- doc/source/caf/plan/cloud-adoption-reasons.rst | 2 +- .../account-and-organizational-structure.rst | 5 ----- doc/source/caf/ready/high-availability.rst | 5 +---- doc/source/caf/ready/index.rst | 2 +- doc/source/caf/ready/network-planning.rst | 15 ++++----------- doc/source/caf/ready/performance.rst | 2 +- doc/source/caf/ready/scalability.rst | 5 ----- doc/source/cce_vault.rst | 3 --- doc/source/index.rst | 1 + 17 files changed, 16 insertions(+), 42 deletions(-) diff --git a/doc/source/caf/adopt/application-migration.rst b/doc/source/caf/adopt/application-migration.rst index 3ff4a71..ba7f8df 100644 --- a/doc/source/caf/adopt/application-migration.rst +++ b/doc/source/caf/adopt/application-migration.rst @@ -70,7 +70,7 @@ are more difficult or that will benefit little. .. image:: ../../assets/caf/image43.png Business Benefits Considerations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Considerations for business benefits include but not limited to: diff --git a/doc/source/caf/adopt/data-management-and-analytics-platform.rst b/doc/source/caf/adopt/data-management-and-analytics-platform.rst index c326eca..17cbb25 100644 --- a/doc/source/caf/adopt/data-management-and-analytics-platform.rst +++ b/doc/source/caf/adopt/data-management-and-analytics-platform.rst @@ -85,7 +85,7 @@ Kafka and Flink. A typical case in point is the mart for querying bank transactions. Open Telekom Cloud FusionInsight Intelligent Data Lake -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This next-generation data lake takes full advantage of cloud-native advantages, such as fast deployment, auto scaling, almost infinite diff --git a/doc/source/caf/adopt/rearchitect.rst b/doc/source/caf/adopt/rearchitect.rst index 1bc4395..d8238f2 100644 --- a/doc/source/caf/adopt/rearchitect.rst +++ b/doc/source/caf/adopt/rearchitect.rst @@ -114,11 +114,6 @@ Application reconstruction can bring the following benefits: databases, and middleware are deployed in multiple AZs. Traffic is distributed through ELB. The underlying data and statuses are synchronized, and applications are deployed in active-active HA mode. - -.. todo:: - - add image of the scale cube - - Container-based reconstruction: Applications are hosted in fast, cost-effective containers that are decoupled from the underlying operating systems. K8S-based CCE provides elastic scheduling for diff --git a/doc/source/caf/govern-and-manage/change-management.rst b/doc/source/caf/govern-and-manage/change-management.rst index 24d3974..ca53157 100644 --- a/doc/source/caf/govern-and-manage/change-management.rst +++ b/doc/source/caf/govern-and-manage/change-management.rst @@ -158,7 +158,7 @@ The change implementer implements the change results and time taken. The change applicant verifies the change -+++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++++++ - Verify the change according to the plan and check whether the purpose has been achieved. If it has not, report this to the change diff --git a/doc/source/caf/govern-and-manage/cost-management.rst b/doc/source/caf/govern-and-manage/cost-management.rst index 28c5534..eaffb0f 100644 --- a/doc/source/caf/govern-and-manage/cost-management.rst +++ b/doc/source/caf/govern-and-manage/cost-management.rst @@ -33,7 +33,7 @@ expensive than high-performance computing instances of the same specifications (for example, 8 vCPUs \| 16 GB). Instance specifications selection -++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++ Huawei Cloud provides dozens of instance specifications for you to choose from. You can choose diff --git a/doc/source/caf/govern-and-manage/emergency-handling.rst b/doc/source/caf/govern-and-manage/emergency-handling.rst index 369359a..a66d2b2 100644 --- a/doc/source/caf/govern-and-manage/emergency-handling.rst +++ b/doc/source/caf/govern-and-manage/emergency-handling.rst @@ -113,7 +113,7 @@ Remarks: to resolve or transfer out an incident. Incident escalation and notification -*********************************** +************************************ The notification mechanism defined in the following table is for incidents that are Level 1 and 2. diff --git a/doc/source/caf/index.rst b/doc/source/caf/index.rst index 5d1b759..1303fc8 100644 --- a/doc/source/caf/index.rst +++ b/doc/source/caf/index.rst @@ -52,6 +52,7 @@ Let's see these phases one by one: ready/index.rst adopt/index.rst govern-and-manage/index.rst + concluding-remarks.rst Intended Audiences ++++++++++++++++++ diff --git a/doc/source/caf/plan/cloud-adoption-dimensions.rst b/doc/source/caf/plan/cloud-adoption-dimensions.rst index ac50d1d..6f5d3e1 100644 --- a/doc/source/caf/plan/cloud-adoption-dimensions.rst +++ b/doc/source/caf/plan/cloud-adoption-dimensions.rst @@ -42,7 +42,7 @@ Currently, IT systems are facing the following challenges: on transforming their digital capabilities. Data intelligence and data security -********************************** +*********************************** Data has become a new production factor together with traditional factors such as land, labor, capital, and technology. diff --git a/doc/source/caf/plan/cloud-adoption-reasons.rst b/doc/source/caf/plan/cloud-adoption-reasons.rst index 539bb49..6a86e52 100644 --- a/doc/source/caf/plan/cloud-adoption-reasons.rst +++ b/doc/source/caf/plan/cloud-adoption-reasons.rst @@ -44,7 +44,7 @@ costs. In addition, the trial-and-error costs of trying out a new service can be significantly reduced. Enhancing O&M efficiency -*********************** +************************ Experienced O&M teams with hundreds or thousands of people from cloud service vendors provide professional services, significantly enhancing diff --git a/doc/source/caf/ready/account-and-organizational-structure.rst b/doc/source/caf/ready/account-and-organizational-structure.rst index 13a7596..c2fc3f5 100644 --- a/doc/source/caf/ready/account-and-organizational-structure.rst +++ b/doc/source/caf/ready/account-and-organizational-structure.rst @@ -2,11 +2,6 @@ Account and Organizational Structure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. todo:: - - remove instances of HUA specific services and offerings. - - The Landing Zone solution needs a secure, compliant, and scalable multi-account environment on the cloud. diff --git a/doc/source/caf/ready/high-availability.rst b/doc/source/caf/ready/high-availability.rst index f0bc112..069ffab 100644 --- a/doc/source/caf/ready/high-availability.rst +++ b/doc/source/caf/ready/high-availability.rst @@ -2,7 +2,7 @@ High Availability ================= Availability Definition ----------------------- +----------------------- Availability refers to the ability of a product or service to perform a specified function under specified conditions at a specified time or @@ -70,9 +70,6 @@ other AZs. There are four types of HA deployments: deployment. Enterprises can deploy production services on Open Telekom Cloud and deploy the DR site on a cloud vendor platform. -.. todo:: - review the above, especially the last whether is feasible in OTC - Single-AZ HA Solution Design ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/caf/ready/index.rst b/doc/source/caf/ready/index.rst index 5fe2f50..76920fb 100644 --- a/doc/source/caf/ready/index.rst +++ b/doc/source/caf/ready/index.rst @@ -1,5 +1,5 @@ Phase 2: Ready -============= +============== To build a highly reliable and available system on the cloud, a systematic top-level design framework and unified standards are diff --git a/doc/source/caf/ready/network-planning.rst b/doc/source/caf/ready/network-planning.rst index e7dfd31..4321650 100644 --- a/doc/source/caf/ready/network-planning.rst +++ b/doc/source/caf/ready/network-planning.rst @@ -6,9 +6,6 @@ network architecture. You need to review the current status of the data center network and operational model and translate them as multi-account and network design plans on the cloud (including VPCs, subnets, and communication between cloud and on-premises networks). -.. todo:: - remove all references of Huawei in images - On-Premises Network Review '''''''''''''''''''''''''' @@ -99,10 +96,6 @@ Cloud Networking Planning and Design '''''''''''''''''''''''''''''''''''' .. image:: ../../assets/caf/image10.png - :alt: The following figure shows a typical networking solution. The - following scenarios include VPC and subnet on the cloud, Internet - communication on the cloud, O&M network on the cloud, and communication - between cloud and on-premises networks. VPCs and Subnets **************** @@ -205,7 +198,7 @@ requirements. | | | | | backbone network | | | | | | and ensures the | | | | | | network SLA on | -| | | | | Open Telekom Cloud. | +| | | | | OTC. | +----------+------------+-------------+-------------+------------------+ | | Network | Low, billed | High, | Medium, billed | | | f | annually, | pay-per-use | annually, | @@ -241,7 +234,7 @@ requirements. +----------+------------+-------------+-------------+------------------+ Connect networks of on-premises data centers, campus, branches, and mobile offices to Open Telekom Cloud -************************************************************************************************* +******************************************************************************************************** .. image:: ../../assets/caf/image22.png @@ -271,7 +264,7 @@ on-premises data center or campus to connect to Open Telekom Cloud public O&M VPC. Mobile offices or stores -``````````````````````` +```````````````````````` An enterprise may have many offline stores or branches. Business systems such as mobile POS systems need to @@ -315,7 +308,7 @@ efficient, and cost-effective. .. image:: ../../assets/caf/image24.png On-premises data center accessing the Internet through Open Telekom Cloud -``````````````````````````````````````````````````````````````````` +````````````````````````````````````````````````````````````````````````` If the public network used by the data center is of poor quality and expensive, the data center can be connected to Open Telekom diff --git a/doc/source/caf/ready/performance.rst b/doc/source/caf/ready/performance.rst index 0e92441..d475613 100644 --- a/doc/source/caf/ready/performance.rst +++ b/doc/source/caf/ready/performance.rst @@ -8,7 +8,7 @@ selection, performance measurement, performance monitoring, and performance trade-off must also be considered. Factors that affect the performance of cloud applications -**************************************************** +********************************************************* - **Compute latency**: the wait time between operations and a direct reflection of cloud computing performance - **Network throughput**: the rate at which data is processed diff --git a/doc/source/caf/ready/scalability.rst b/doc/source/caf/ready/scalability.rst index a2e61a3..f3f054b 100644 --- a/doc/source/caf/ready/scalability.rst +++ b/doc/source/caf/ready/scalability.rst @@ -86,11 +86,6 @@ scalable design of each layer is as follows: in a cluster. With the increase of database services, the DDM cluster specifications can be smoothly expanded to cope with more database processing. - -.. todo:: - - DDM exists in OTC? I can find traces in documentation although they are empty - - **Database layer:** Open Telekom Cloud Relational Database Service (RDS) supports smooth expansion of read-only database instances for scenarios where much more data is read than written. By working with diff --git a/doc/source/cce_vault.rst b/doc/source/cce_vault.rst index ae56308..db73e64 100644 --- a/doc/source/cce_vault.rst +++ b/doc/source/cce_vault.rst @@ -30,9 +30,6 @@ internal credentials. Overview ======== -.. graphviz:: dot/cce_vault_overview.dot - :layout: dot - TLS secrets are kept in the Vault. They are being read by Vault Agent component running as a sidecar in Zookeeper service pod and writes certificates onto the file system. Zookeeper services reads certificates populated by Agent. Vault diff --git a/doc/source/index.rst b/doc/source/index.rst index 32eee9c..25aad4e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,4 +12,5 @@ validated recommendations from our experts. .. toctree:: :maxdepth: 1 + caf/index.rst cce_vault.rst