rhaas3/internal-documentation
1
0
Fork 0
forked from docs/internal-documentation
Code Pull Requests Activity

update minor text pieces

Browse Source 
Started to factor out "new" and "HC3.0" references.
This commit is contained in:
Nils Magnus 2024-04-19 12:28:48 +00:00
parent 8f34dfa644
commit 7082013129
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/source/helpcenter/helpcenter_training/introduction.rst
View File

@ -2,36 +2,37 @@
Introduction Introduction
============ ============
The HelpCenter3.0 is Open Telekom Cloud product developed by Ecosystem squad introducing new approach in the documentation management. The Helpcenter 3 (HC3) is an Open Telekom Cloud product developed by the Ecosystem Squad introducing
In order to improve documentation exchange between delivery partners and the TSI a new documentation platform and processes a new approach in documentation management. It improves the documentation exchange between
based on GitOps are introduced with following benefits: 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 - Openness,
- Transparency - Transparency,
- Comprehensive review capabilities - Comprehensive review capabilities,
- Full control during the documentation lifecycle - Full control during the documentation lifecycle, and
- Documentation as a source code - 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, 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 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. to see the complete history of changes tracked by git itself.
.. figure:: /_static/images/helpcenter_gitops.png .. 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 Solution is based on open source components. Its HLD is described at https://docs.otc-service.com/system-config/docsportal.html
Implementation is based on: The implementation is based on these building blocks:
- Restructured Text (RST) as source documentation format - Restructured Text (RST) as source documentation format,
- Gitea/Github as a repository - Gitea/Github as a repository,
- Zuul as a CI/CD engine for workflows - Zuul as a CI/CD engine for workflows,
- Sphinx as a documentation rendering framework (HTML/PDF/... - Sphinx as a documentation rendering framework creating for example HTML or PDF documents,
- OpenSearch as a search engine - OpenSearch as a search engine,
- Swift object storage as a storage for documentation - Swift object storage as a storage for documentation,
- Pandoc as a documentation converter - Pandoc as a documentation converter, and
- OTC Infrastructure (ECS, CCE, ELB, ...) - 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 - Support of UMN, API, DEV and other public facing documents
- PROD and PREPROD documentation portal: - PROD and PREPROD documentation portal: