From 708201312956a679603b5ea667a022ad2d90d394 Mon Sep 17 00:00:00 2001 From: Nils Magnus Date: Fri, 19 Apr 2024 12:28:48 +0000 Subject: [PATCH] update minor text pieces Started to factor out "new" and "HC3.0" references. --- .../helpcenter_training/introduction.rst | 41 ++++++++++--------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/doc/source/helpcenter/helpcenter_training/introduction.rst b/doc/source/helpcenter/helpcenter_training/introduction.rst index b768b35..cd6adaf 100644 --- a/doc/source/helpcenter/helpcenter_training/introduction.rst +++ b/doc/source/helpcenter/helpcenter_training/introduction.rst @@ -2,36 +2,37 @@ Introduction ============ -The HelpCenter3.0 is Open Telekom Cloud product developed by Ecosystem squad introducing new approach in the documentation management. -In order to improve documentation exchange between delivery partners and the TSI a new documentation platform and processes -based on GitOps are introduced with following benefits: +The Helpcenter 3 (HC3) is an Open Telekom Cloud product developed by the Ecosystem Squad introducing +a new approach in documentation management. It improves the documentation exchange between +delivery partners and the service squads of the Open Telekom Cloud. The documentation +platform comes with processes based on GitOps and introduces the following features and benefits: -- Openness -- Transparency -- Comprehensive review capabilities -- Full control during the documentation lifecycle -- Documentation as a source code +- Openness, +- Transparency, +- Comprehensive review capabilities, +- Full control during the documentation lifecycle, and +- Documentation as source code. -The target of the new platform is to store and maintain all documents in Git. This provides benefits of precise identification of changes +The target of the platform is to store and maintain all documents in Git. This provides benefits of precise identification of changes and preventing undesired versions to be published. The process is heavily streamlined. Once, those changes are approved and merged, the connected pipelines ensure that the documentation is published fully automated which eases the document auditing and enables users to see the complete history of changes tracked by git itself. .. figure:: /_static/images/helpcenter_gitops.png -Solution is completely open source based and HLD is described at https://docs.otc-service.com/system-config/docsportal.html -Implementation is based on: +Solution is based on open source components. Its HLD is described at https://docs.otc-service.com/system-config/docsportal.html +The implementation is based on these building blocks: -- Restructured Text (RST) as source documentation format -- Gitea/Github as a repository -- Zuul as a CI/CD engine for workflows -- Sphinx as a documentation rendering framework (HTML/PDF/... -- OpenSearch as a search engine -- Swift object storage as a storage for documentation -- Pandoc as a documentation converter -- OTC Infrastructure (ECS, CCE, ELB, ...) +- Restructured Text (RST) as source documentation format, +- Gitea/Github as a repository, +- Zuul as a CI/CD engine for workflows, +- Sphinx as a documentation rendering framework creating for example HTML or PDF documents, +- OpenSearch as a search engine, +- Swift object storage as a storage for documentation, +- Pandoc as a documentation converter, and +- a lot of OTC Infrastructure (ECS, CCE, ELB, ...) -HC3.0 comes with the following features: +HC3 comes with following features: - Support of UMN, API, DEV and other public facing documents - PROD and PREPROD documentation portal: