hc_ops

Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>

doc/source/apimon/apimon_training/contact.rst

@@ -26,4 +26,4 @@ If there is another issue/demand/request try to locate proper repository in
 https://github.com/orgs/stackmon/repositories
 
 For general questions you can write an E-Mail to the `Ecosystems Squad
-<mailto:dl-pbcotcdeleco@t-systems.com>`_.
+<mailto:dl-pbcotcdeleco@t-systems.com>`_.

doc/source/apimon/apimon_training/logs.rst

@@ -40,6 +40,6 @@ Logs
 
 
 For further details how to work with logs please refer to
-:ref:`How To Read The Logs And Understand The Issue <working_with_logs>` FAQ 
+:ref:`How To Read The Logs And Understand The Issue <working_with_logs>` FAQ
 page.
 

doc/source/apimon/apimon_training/notifications.rst

@@ -21,7 +21,7 @@ If the error has been acknowledged on Alerta, the new notification message for
 repeating error won't get posted again on Zulip.
 
 Notifications contain further details which help to identify root cause faster
-and more effectively. 
+and more effectively.
 
 Notification parameters
 #######################
@@ -63,6 +63,3 @@ Th EpMon notification consists of several fields:
 +----------------------------+------------------------------------------------------------------+
 | **Request error response** | Error result of the requested API call                           |
 +----------------------------+------------------------------------------------------------------+
-
-  
-

doc/source/apimon/apimon_training/test_scenarios.rst

@@ -117,7 +117,7 @@ OpenStack SDK and otcextensions (otcextensions covers services which are out of
 scope of OpenStack SDK and extends its functionality with services provided by
 OTC) support metric generation natively for every single API call and ApiMon
 executor supports collection of ansible playbook statistics so every single
-scenario and task can store its result, duration and name in metric database. 
+scenario and task can store its result, duration and name in metric database.
 
 But in some cases there's a need to provide measurement on multiple tasks which
 represent some important aspect of the customer use case. For example measure

doc/source/apimon/apimon_training/workflow.rst

@@ -25,4 +25,3 @@ ApiMon Flow Process
    alerts on Alerta.
 #. 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.
-    

doc/source/apimon/index.rst

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

doc/source/cpn/backend/index.rst

@@ -0,0 +1,14 @@
+=======
+Backend
+=======
+
+Updating the Backend
+--------------------
+
+You can update the Backend by following those steps:
+
+1. Merge the Pull-Request
+2. Wait until the gate job has been passed
+3. Look at the Zuul-logs from the gate job. Find the line with `Successfully tagged quay.io` and remember the `:change_xx_latest` value
+4. Open a Pull-Request to adjust the kustomization config to the new tag from step 3. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/overlays/prod/kustomization.yaml#L14
+5. Merge this Pull-Request and wait 10 minutes.

doc/source/cpn/frontend/index.rst

@@ -0,0 +1,17 @@
+========
+Frontend
+========
+
+Updating the Frontend
+---------------------
+
+You can update the Frontend by following those steps:
+
+1. Merge the Pull-Request
+2. Tag the desired commit and push the tag to Github. It should be visible afterwards on this page: https://github.com/opentelekomcloud-infra/circle-partner-navigator-frontend/tags
+3. Wait at least 10 minutes
+4. Check whether your tag has been successfully published to the container repository: https://quay.io/repository/opentelekomcloud/circle-partner-navigator-frontend?tab=tags
+5. Open a Pull-Request to adjust the kustomization config to the new tag. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/overlays/prod/kustomization.yaml#L16
+6. Merge this Pull-Request and wait 10 minutes.
+
+Be aware that updating the Frontend will also pull the data from the Backend again and as a result will also update the partner data on the website.

doc/source/cpn/index.rst

@@ -0,0 +1,9 @@
+========================
+Circle Partner Navigator
+========================
+
+.. toctree::
+    :maxdepth: 1
+
+    backend/index
+    frontend/index

doc/source/helpcenter/hc_ops/backstage_add_repo.rst

@@ -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

doc/source/helpcenter/hc_ops/index.rst

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

doc/source/helpcenter/helpcenter_training/contact.rst

@@ -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
 
-
-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>`_.