Compare commits

...

2 Commits
main ... hc_ops

Author SHA1 Message Date
d432aaa686 fix pep8 and add new content for helpcenter 2024-02-22 14:26:20 +00:00
db781e73c9 sort the internal repo 2024-02-22 14:06:01 +00:00
112 changed files with 160 additions and 60 deletions

View File

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

View File

@ -63,6 +63,3 @@ Th EpMon notification consists of several fields:
+----------------------------+------------------------------------------------------------------+ +----------------------------+------------------------------------------------------------------+
| **Request error response** | Error result of the requested API call | | **Request error response** | Error result of the requested API call |
+----------------------------+------------------------------------------------------------------+ +----------------------------+------------------------------------------------------------------+

View File

Before

Width:  |  Height:  |  Size: 188 KiB

After

Width:  |  Height:  |  Size: 188 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 101 KiB

View File

@ -25,4 +25,3 @@ ApiMon Flow Process
alerts on Alerta. alerts on Alerta.
#. Notifications containing alert details are sent to Zulip #. Notifications containing alert details are sent to Zulip
#. Every test scenario stores it's job output log into Swift object storage for further analysis and investigation. #. Every test scenario stores it's job output log into Swift object storage for further analysis and investigation.

View File

@ -0,0 +1,8 @@
=============================
APImon Internal Documentation
=============================
.. toctree::
:maxdepth: 2
apimon_training/index

View File

@ -0,0 +1,79 @@
===================================
Add a new Repository with Backstage
===================================
This document describes the steps to be done to register a new Helpcenter Repository.
1. Register the Service in infra/metadata
-----------------------------------------
Modify the following sample files for your need and open a Pull Request in the respective Gitea Repository.
Service registration under: `otc_metadata/data/services <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/services>`_
.. code::
---
environment: public
repositories:
- environment: internal
repo: docs/cloud-container-engine
type: gitea
- environment: public
repo: opentelekomcloud-docs/cloud-container-engine
type: github
service_category: container
service_title: Cloud Container Engine
service_type: cce
service_uri: cloud-container-engine
teams:
- name: docs-container-rw
permission: write
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
.. code::
---
hc_location: usermanual2/cce
html_location: docs/cce/umn
link: /cloud-container-engine/umn/
rst_location: umn/source
service_type: cce
title: User Guide
type: umn
2. Use Backstage to create a Git internal / public Repository
-------------------------------------------------------------
- Open Backstage under: https://backstage.eco.tsi-dev.otc-service.com/
- Navigate to :code:`Create...` in the left sidebar
- Choose :code:`Helpcenter Service` from the list in the main section
- Fill in the necessary information to create a Helpcenter repository in Gitea (internal)
.. figure:: images/hc_service.png
- Fill in the necessary information to create a Helpcenter repository in GitHub (public)
.. image:: images/hc_service2.png
3. Use Backstage to register the repositories to Zuul and set proper gitstyring permissions
-------------------------------------------------------------------------------------------
- Open Backstage under: https://backstage.eco.tsi-dev.otc-service.com/
- Navigate to :code:`Create...` in the left sidebar
- Choose :code:`Action: Register repository in Zuul` from the list in the main section
- Fill in the necessary information as shown in the screenshots below
.. image:: images/hc_service3.png
.. image:: images/hc_service4.png
4. Approve Changes for gitstyring and Zuul
------------------------------------------
- Navigate to gitstyring repository in Gitea: https://gitea.eco.tsi-dev.otc-service.com/infra/gitstyring/pulls/
- Review and approve changes in the related Pull Request
- Wait until Gate-process has been finished
- Navigate to Zuul repository in Github: https://github.com/opentelekomcloud-infra/zuul-config/pulls
- Review and approve changes in the related Pull Request

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -0,0 +1,8 @@
=====================
Helpcenter Operations
=====================
.. toctree::
:maxdepth: 2
backstage_add_repo

View File

@ -14,5 +14,4 @@ If you have found any problems which affects the **production Helpcenter** pleas
If there is a request for completely new service or new document type (which was not yet introduced to HelpCenter 3.0) then please open an issue on the otc-metadata repository: https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/issues If there is a request for completely new service or new document type (which was not yet introduced to HelpCenter 3.0) then please open an issue on the otc-metadata repository: https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/issues
For general questions you can write an E-Mail to the `Ecosystems Squad <mailto:dl-pbcotcdeleco@t-systems.com>`_. For general questions you can write an E-Mail to the `Ecosystems Squad <mailto:dl-pbcotcdeleco@t-systems.com>`_.

View File

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 141 KiB

Some files were not shown because too many files have changed in this diff Show More