diff --git a/doc/source/training/apimon_training/alerts.rst b/doc/source/apimon/apimon_training/alerts.rst similarity index 100% rename from doc/source/training/apimon_training/alerts.rst rename to doc/source/apimon/apimon_training/alerts.rst diff --git a/doc/source/training/apimon_training/contact.rst b/doc/source/apimon/apimon_training/contact.rst similarity index 96% rename from doc/source/training/apimon_training/contact.rst rename to doc/source/apimon/apimon_training/contact.rst index 7a37812..5434128 100644 --- a/doc/source/training/apimon_training/contact.rst +++ b/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 -`_. \ No newline at end of file +`_. diff --git a/doc/source/training/apimon_training/dashboards.rst b/doc/source/apimon/apimon_training/dashboards.rst similarity index 100% rename from doc/source/training/apimon_training/dashboards.rst rename to doc/source/apimon/apimon_training/dashboards.rst diff --git a/doc/source/training/apimon_training/databases.rst b/doc/source/apimon/apimon_training/databases.rst similarity index 100% rename from doc/source/training/apimon_training/databases.rst rename to doc/source/apimon/apimon_training/databases.rst diff --git a/doc/source/training/apimon_training/difference_cmo_fmo.rst b/doc/source/apimon/apimon_training/difference_cmo_fmo.rst similarity index 100% rename from doc/source/training/apimon_training/difference_cmo_fmo.rst rename to doc/source/apimon/apimon_training/difference_cmo_fmo.rst diff --git a/doc/source/training/apimon_training/epmon_checks.rst b/doc/source/apimon/apimon_training/epmon_checks.rst similarity index 100% rename from doc/source/training/apimon_training/epmon_checks.rst rename to doc/source/apimon/apimon_training/epmon_checks.rst diff --git a/doc/source/training/apimon_training/faq/faq_images/alerta_alerts_detail.png b/doc/source/apimon/apimon_training/faq/faq_images/alerta_alerts_detail.png similarity index 100% rename from doc/source/training/apimon_training/faq/faq_images/alerta_alerts_detail.png rename to doc/source/apimon/apimon_training/faq/faq_images/alerta_alerts_detail.png diff --git a/doc/source/training/apimon_training/faq/faq_images/annotations.jpg b/doc/source/apimon/apimon_training/faq/faq_images/annotations.jpg similarity index 100% rename from doc/source/training/apimon_training/faq/faq_images/annotations.jpg rename to doc/source/apimon/apimon_training/faq/faq_images/annotations.jpg diff --git a/doc/source/training/apimon_training/faq/faq_images/dashboard_log_links.jpg b/doc/source/apimon/apimon_training/faq/faq_images/dashboard_log_links.jpg similarity index 100% rename from doc/source/training/apimon_training/faq/faq_images/dashboard_log_links.jpg rename to doc/source/apimon/apimon_training/faq/faq_images/dashboard_log_links.jpg diff --git a/doc/source/training/apimon_training/faq/faq_images/zulip_notification_links.jpg b/doc/source/apimon/apimon_training/faq/faq_images/zulip_notification_links.jpg similarity index 100% rename from doc/source/training/apimon_training/faq/faq_images/zulip_notification_links.jpg rename to doc/source/apimon/apimon_training/faq/faq_images/zulip_notification_links.jpg diff --git a/doc/source/training/apimon_training/faq/how_can_i_access_dashboard.rst b/doc/source/apimon/apimon_training/faq/how_can_i_access_dashboard.rst similarity index 100% rename from doc/source/training/apimon_training/faq/how_can_i_access_dashboard.rst rename to doc/source/apimon/apimon_training/faq/how_can_i_access_dashboard.rst diff --git a/doc/source/training/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst b/doc/source/apimon/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst similarity index 100% rename from doc/source/training/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst rename to doc/source/apimon/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst diff --git a/doc/source/training/apimon_training/faq/index.rst b/doc/source/apimon/apimon_training/faq/index.rst similarity index 100% rename from doc/source/training/apimon_training/faq/index.rst rename to doc/source/apimon/apimon_training/faq/index.rst diff --git a/doc/source/training/apimon_training/faq/what_are_the_annotations.rst b/doc/source/apimon/apimon_training/faq/what_are_the_annotations.rst similarity index 100% rename from doc/source/training/apimon_training/faq/what_are_the_annotations.rst rename to doc/source/apimon/apimon_training/faq/what_are_the_annotations.rst diff --git a/doc/source/training/apimon_training/index.rst b/doc/source/apimon/apimon_training/index.rst similarity index 100% rename from doc/source/training/apimon_training/index.rst rename to doc/source/apimon/apimon_training/index.rst diff --git a/doc/source/training/apimon_training/introduction.rst b/doc/source/apimon/apimon_training/introduction.rst similarity index 100% rename from doc/source/training/apimon_training/introduction.rst rename to doc/source/apimon/apimon_training/introduction.rst diff --git a/doc/source/training/apimon_training/logs.rst b/doc/source/apimon/apimon_training/logs.rst similarity index 99% rename from doc/source/training/apimon_training/logs.rst rename to doc/source/apimon/apimon_training/logs.rst index 68d46f9..0b04ee1 100644 --- a/doc/source/training/apimon_training/logs.rst +++ b/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 ` FAQ +:ref:`How To Read The Logs And Understand The Issue ` FAQ page. diff --git a/doc/source/training/apimon_training/metrics.rst b/doc/source/apimon/apimon_training/metrics.rst similarity index 100% rename from doc/source/training/apimon_training/metrics.rst rename to doc/source/apimon/apimon_training/metrics.rst diff --git a/doc/source/training/apimon_training/monitoring_coverage.rst b/doc/source/apimon/apimon_training/monitoring_coverage.rst similarity index 100% rename from doc/source/training/apimon_training/monitoring_coverage.rst rename to doc/source/apimon/apimon_training/monitoring_coverage.rst diff --git a/doc/source/training/apimon_training/notifications.rst b/doc/source/apimon/apimon_training/notifications.rst similarity index 99% rename from doc/source/training/apimon_training/notifications.rst rename to doc/source/apimon/apimon_training/notifications.rst index 123c0bd..82b89fa 100644 --- a/doc/source/training/apimon_training/notifications.rst +++ b/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 | +----------------------------+------------------------------------------------------------------+ - - - diff --git a/doc/source/training/apimon_training/recorded_session.rst b/doc/source/apimon/apimon_training/recorded_session.rst similarity index 100% rename from doc/source/training/apimon_training/recorded_session.rst rename to doc/source/apimon/apimon_training/recorded_session.rst diff --git a/doc/source/training/apimon_training/test_scenarios.rst b/doc/source/apimon/apimon_training/test_scenarios.rst similarity index 99% rename from doc/source/training/apimon_training/test_scenarios.rst rename to doc/source/apimon/apimon_training/test_scenarios.rst index b87c3de..6720156 100644 --- a/doc/source/training/apimon_training/test_scenarios.rst +++ b/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 diff --git a/doc/source/training/apimon_training/training_images/24_7_dashboard.jpg b/doc/source/apimon/apimon_training/training_images/24_7_dashboard.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/24_7_dashboard.jpg rename to doc/source/apimon/apimon_training/training_images/24_7_dashboard.jpg diff --git a/doc/source/training/apimon_training/training_images/alerta_alerts.png b/doc/source/apimon/apimon_training/training_images/alerta_alerts.png similarity index 100% rename from doc/source/training/apimon_training/training_images/alerta_alerts.png rename to doc/source/apimon/apimon_training/training_images/alerta_alerts.png diff --git a/doc/source/training/apimon_training/training_images/alerta_dashboard.png b/doc/source/apimon/apimon_training/training_images/alerta_dashboard.png similarity index 100% rename from doc/source/training/apimon_training/training_images/alerta_dashboard.png rename to doc/source/apimon/apimon_training/training_images/alerta_dashboard.png diff --git a/doc/source/training/apimon_training/training_images/alerta_detail.jpg b/doc/source/apimon/apimon_training/training_images/alerta_detail.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/alerta_detail.jpg rename to doc/source/apimon/apimon_training/training_images/alerta_detail.jpg diff --git a/doc/source/training/apimon_training/training_images/apimon_data_flow.svg b/doc/source/apimon/apimon_training/training_images/apimon_data_flow.svg similarity index 100% rename from doc/source/training/apimon_training/training_images/apimon_data_flow.svg rename to doc/source/apimon/apimon_training/training_images/apimon_data_flow.svg diff --git a/doc/source/training/apimon_training/training_images/apimon_test_results.jpg b/doc/source/apimon/apimon_training/training_images/apimon_test_results.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/apimon_test_results.jpg rename to doc/source/apimon/apimon_training/training_images/apimon_test_results.jpg diff --git a/doc/source/training/apimon_training/training_images/compute_service_statistics_1.jpg b/doc/source/apimon/apimon_training/training_images/compute_service_statistics_1.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/compute_service_statistics_1.jpg rename to doc/source/apimon/apimon_training/training_images/compute_service_statistics_1.jpg diff --git a/doc/source/training/apimon_training/training_images/compute_service_statistics_2.jpg b/doc/source/apimon/apimon_training/training_images/compute_service_statistics_2.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/compute_service_statistics_2.jpg rename to doc/source/apimon/apimon_training/training_images/compute_service_statistics_2.jpg diff --git a/doc/source/training/apimon_training/training_images/dashboards.png b/doc/source/apimon/apimon_training/training_images/dashboards.png similarity index 100% rename from doc/source/training/apimon_training/training_images/dashboards.png rename to doc/source/apimon/apimon_training/training_images/dashboards.png diff --git a/doc/source/training/apimon_training/training_images/epmon_dashboard_details.jpg b/doc/source/apimon/apimon_training/training_images/epmon_dashboard_details.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/epmon_dashboard_details.jpg rename to doc/source/apimon/apimon_training/training_images/epmon_dashboard_details.jpg diff --git a/doc/source/training/apimon_training/training_images/epmon_status_dashboard.jpg b/doc/source/apimon/apimon_training/training_images/epmon_status_dashboard.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/epmon_status_dashboard.jpg rename to doc/source/apimon/apimon_training/training_images/epmon_status_dashboard.jpg diff --git a/doc/source/training/apimon_training/training_images/graphite_query.jpg b/doc/source/apimon/apimon_training/training_images/graphite_query.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/graphite_query.jpg rename to doc/source/apimon/apimon_training/training_images/graphite_query.jpg diff --git a/doc/source/training/apimon_training/training_images/kpi_dashboard.png b/doc/source/apimon/apimon_training/training_images/kpi_dashboard.png similarity index 100% rename from doc/source/training/apimon_training/training_images/kpi_dashboard.png rename to doc/source/apimon/apimon_training/training_images/kpi_dashboard.png diff --git a/doc/source/training/apimon_training/training_images/postgresql_query.jpg b/doc/source/apimon/apimon_training/training_images/postgresql_query.jpg similarity index 100% rename from doc/source/training/apimon_training/training_images/postgresql_query.jpg rename to doc/source/apimon/apimon_training/training_images/postgresql_query.jpg diff --git a/doc/source/training/apimon_training/training_images/zulip_notifications.png b/doc/source/apimon/apimon_training/training_images/zulip_notifications.png similarity index 100% rename from doc/source/training/apimon_training/training_images/zulip_notifications.png rename to doc/source/apimon/apimon_training/training_images/zulip_notifications.png diff --git a/doc/source/training/apimon_training/workflow.rst b/doc/source/apimon/apimon_training/workflow.rst similarity index 99% rename from doc/source/training/apimon_training/workflow.rst rename to doc/source/apimon/apimon_training/workflow.rst index 3fa1c6d..f770710 100644 --- a/doc/source/training/apimon_training/workflow.rst +++ b/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. - diff --git a/doc/source/apimon/index.rst b/doc/source/apimon/index.rst new file mode 100644 index 0000000..71d1423 --- /dev/null +++ b/doc/source/apimon/index.rst @@ -0,0 +1,8 @@ +============================= +APImon Internal Documentation +============================= + +.. toctree:: + :maxdepth: 2 + + apimon_training/index diff --git a/doc/source/cpn/index.rst b/doc/source/cpn/index.rst index 05671b7..98597e7 100644 --- a/doc/source/cpn/index.rst +++ b/doc/source/cpn/index.rst @@ -3,7 +3,7 @@ Circle Partner Navigator ======================== .. toctree:: - :maxdepth: 1 + :maxdepth: 1 backend/index frontend/index diff --git a/doc/source/helpcenter/hc_ops/backstage_add_repo.rst b/doc/source/helpcenter/hc_ops/backstage_add_repo.rst new file mode 100644 index 0000000..44225dd --- /dev/null +++ b/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 `_ + +.. 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 `_ + +.. 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 diff --git a/doc/source/helpcenter/hc_ops/images/hc_service.png b/doc/source/helpcenter/hc_ops/images/hc_service.png new file mode 100644 index 0000000..369e957 Binary files /dev/null and b/doc/source/helpcenter/hc_ops/images/hc_service.png differ diff --git a/doc/source/helpcenter/hc_ops/images/hc_service2.png b/doc/source/helpcenter/hc_ops/images/hc_service2.png new file mode 100644 index 0000000..10639d5 Binary files /dev/null and b/doc/source/helpcenter/hc_ops/images/hc_service2.png differ diff --git a/doc/source/helpcenter/hc_ops/images/hc_service3.png b/doc/source/helpcenter/hc_ops/images/hc_service3.png new file mode 100644 index 0000000..c1eddec Binary files /dev/null and b/doc/source/helpcenter/hc_ops/images/hc_service3.png differ diff --git a/doc/source/helpcenter/hc_ops/images/hc_service4.png b/doc/source/helpcenter/hc_ops/images/hc_service4.png new file mode 100644 index 0000000..99ecb32 Binary files /dev/null and b/doc/source/helpcenter/hc_ops/images/hc_service4.png differ diff --git a/doc/source/helpcenter/hc_ops/index.rst b/doc/source/helpcenter/hc_ops/index.rst new file mode 100644 index 0000000..d364dc7 --- /dev/null +++ b/doc/source/helpcenter/hc_ops/index.rst @@ -0,0 +1,8 @@ +===================== +Helpcenter Operations +===================== + +.. toctree:: + :maxdepth: 2 + + backstage_add_repo diff --git a/doc/source/training/helpcenter_training/contact.rst b/doc/source/helpcenter/helpcenter_training/contact.rst similarity index 96% rename from doc/source/training/helpcenter_training/contact.rst rename to doc/source/helpcenter/helpcenter_training/contact.rst index 1aacc33..d8b61bf 100644 --- a/doc/source/training/helpcenter_training/contact.rst +++ b/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 `_. \ No newline at end of file +For general questions you can write an E-Mail to the `Ecosystems Squad `_. diff --git a/doc/source/training/helpcenter_training/difference_gitea_github.rst b/doc/source/helpcenter/helpcenter_training/difference_gitea_github.rst similarity index 100% rename from doc/source/training/helpcenter_training/difference_gitea_github.rst rename to doc/source/helpcenter/helpcenter_training/difference_gitea_github.rst diff --git a/doc/source/training/helpcenter_training/faq/are_there_any_plans_to_move_other_documents_cdr_hld_and_pd_as_well_to_the_platform_so_we_can_handle_all_documents_in_one_place.rst b/doc/source/helpcenter/helpcenter_training/faq/are_there_any_plans_to_move_other_documents_cdr_hld_and_pd_as_well_to_the_platform_so_we_can_handle_all_documents_in_one_place.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/are_there_any_plans_to_move_other_documents_cdr_hld_and_pd_as_well_to_the_platform_so_we_can_handle_all_documents_in_one_place.rst rename to doc/source/helpcenter/helpcenter_training/faq/are_there_any_plans_to_move_other_documents_cdr_hld_and_pd_as_well_to_the_platform_so_we_can_handle_all_documents_in_one_place.rst diff --git a/doc/source/training/helpcenter_training/faq/faq_images/gate_label.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gate_label.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/gate_label.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/gate_label.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_1.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_1.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_1.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_1.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_2.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_2.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_2.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_3.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_3.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_3.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_3.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_4.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_4.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_4.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_4.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_5.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_5.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_5.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_5.png diff --git a/doc/source/training/helpcenter_training/faq/faq_images/html_preview_6.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_6.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/html_preview_6.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/html_preview_6.png diff --git a/doc/source/training/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_a_non-conformity_is_found_in_an_already_released_deployed_prod_documentation.rst b/doc/source/helpcenter/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_a_non-conformity_is_found_in_an_already_released_deployed_prod_documentation.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_a_non-conformity_is_found_in_an_already_released_deployed_prod_documentation.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_a_non-conformity_is_found_in_an_already_released_deployed_prod_documentation.rst diff --git a/doc/source/training/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_the_documentation_url_is_wrong_the_link_is_not_working.rst b/doc/source/helpcenter/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_the_documentation_url_is_wrong_the_link_is_not_working.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_the_documentation_url_is_wrong_the_link_is_not_working.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_and_where_should_we_submit_bugs_when_the_documentation_url_is_wrong_the_link_is_not_working.rst diff --git a/doc/source/training/helpcenter_training/faq/how_can_the_docs_be_deployed_to_pre-prod_and_prod_and_who_will_be_the_responsible_to_do_that.rst b/doc/source/helpcenter/helpcenter_training/faq/how_can_the_docs_be_deployed_to_pre-prod_and_prod_and_who_will_be_the_responsible_to_do_that.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_can_the_docs_be_deployed_to_pre-prod_and_prod_and_who_will_be_the_responsible_to_do_that.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_can_the_docs_be_deployed_to_pre-prod_and_prod_and_who_will_be_the_responsible_to_do_that.rst diff --git a/doc/source/training/helpcenter_training/faq/how_can_we_accept_the_entire_document_when_we_are_fine_with_it_who_will_have_the_right_to_make_a_doc_version_final.rst b/doc/source/helpcenter/helpcenter_training/faq/how_can_we_accept_the_entire_document_when_we_are_fine_with_it_who_will_have_the_right_to_make_a_doc_version_final.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_can_we_accept_the_entire_document_when_we_are_fine_with_it_who_will_have_the_right_to_make_a_doc_version_final.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_can_we_accept_the_entire_document_when_we_are_fine_with_it_who_will_have_the_right_to_make_a_doc_version_final.rst diff --git a/doc/source/training/helpcenter_training/faq/how_can_we_revert_back_to_a_previous_document_version.rst b/doc/source/helpcenter/helpcenter_training/faq/how_can_we_revert_back_to_a_previous_document_version.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_can_we_revert_back_to_a_previous_document_version.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_can_we_revert_back_to_a_previous_document_version.rst diff --git a/doc/source/training/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst b/doc/source/helpcenter/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst diff --git a/doc/source/training/helpcenter_training/faq/how_does_document_versioning_work_during_the_document_updates_how_will_the_final_accepted_document_be_versioned.rst b/doc/source/helpcenter/helpcenter_training/faq/how_does_document_versioning_work_during_the_document_updates_how_will_the_final_accepted_document_be_versioned.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_does_document_versioning_work_during_the_document_updates_how_will_the_final_accepted_document_be_versioned.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_does_document_versioning_work_during_the_document_updates_how_will_the_final_accepted_document_be_versioned.rst diff --git a/doc/source/training/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst b/doc/source/helpcenter/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst diff --git a/doc/source/training/helpcenter_training/faq/how_the_document_traceability_to_dms_rms_in_jira_will_work_who_will_be_the_responsible_to_place_the_links_in_the_related_jira_ticket.rst b/doc/source/helpcenter/helpcenter_training/faq/how_the_document_traceability_to_dms_rms_in_jira_will_work_who_will_be_the_responsible_to_place_the_links_in_the_related_jira_ticket.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_the_document_traceability_to_dms_rms_in_jira_will_work_who_will_be_the_responsible_to_place_the_links_in_the_related_jira_ticket.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_the_document_traceability_to_dms_rms_in_jira_will_work_who_will_be_the_responsible_to_place_the_links_in_the_related_jira_ticket.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_accept_a_single_change_comment.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_accept_a_single_change_comment.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_to_accept_a_single_change_comment.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_accept_a_single_change_comment.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_create_a_gitea_account.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_create_a_gitea_account.rst similarity index 90% rename from doc/source/training/helpcenter_training/faq/how_to_create_a_gitea_account.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_create_a_gitea_account.rst index e85c234..84f9b9a 100644 --- a/doc/source/training/helpcenter_training/faq/how_to_create_a_gitea_account.rst +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_create_a_gitea_account.rst @@ -7,5 +7,5 @@ You should immediately be logged-in with your account. If you want to be able to use Single-Sign-On with your GitHub account, please write an E-Mail to the `Ecosystems Squad `_. -Once your GitHub account has been approved, you can Log-In into Gitea using the button in the top-right corner. Select "Sign In With OpenID" and then click on the GitHub button. -In case the system asks you to link accounts because you have an LDAP and GitHub account registered, please choose "Link accounts" and Log-In once with your LDAP credentials. After that, you can always Log-In through GitHub. \ No newline at end of file +Once your GitHub account has been approved, you can Log-In into Gitea using the button in the top-right corner. Select "Sign In With OpenID" and then click on the GitHub button. +In case the system asks you to link accounts because you have an LDAP and GitHub account registered, please choose "Link accounts" and Log-In once with your LDAP credentials. After that, you can always Log-In through GitHub. diff --git a/doc/source/training/helpcenter_training/faq/how_to_reply_to_a_comment.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_reply_to_a_comment.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_to_reply_to_a_comment.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_reply_to_a_comment.rst diff --git a/doc/source/training/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst similarity index 97% rename from doc/source/training/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst index a8635d8..172d449 100644 --- a/doc/source/training/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_request_a_document_modification_for_a_single_comment_or_for_multiple_comments__how_to_notify_huawei_that_we_need_an_update.rst @@ -10,5 +10,4 @@ After finishing the review (and raising the comments) you have 3 options how to - **Request Changes** - Approval is not given and PR is blocked by requesting the changes which means that PR should receive another commit of changes and only after that PR will be ready for next review round -You can see further details at following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Review#finish_review `_ . - +You can see further details at following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Review#finish_review `_ . diff --git a/doc/source/training/helpcenter_training/faq/how_will_we_be_notified_once_huawei_will_upload_something_new_doc_or_modify_existing_doc.rst b/doc/source/helpcenter/helpcenter_training/faq/how_will_we_be_notified_once_huawei_will_upload_something_new_doc_or_modify_existing_doc.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/how_will_we_be_notified_once_huawei_will_upload_something_new_doc_or_modify_existing_doc.rst rename to doc/source/helpcenter/helpcenter_training/faq/how_will_we_be_notified_once_huawei_will_upload_something_new_doc_or_modify_existing_doc.rst diff --git a/doc/source/training/helpcenter_training/faq/index.rst b/doc/source/helpcenter/helpcenter_training/faq/index.rst similarity index 98% rename from doc/source/training/helpcenter_training/faq/index.rst rename to doc/source/helpcenter/helpcenter_training/faq/index.rst index cbd0d07..aa48bc4 100644 --- a/doc/source/training/helpcenter_training/faq/index.rst +++ b/doc/source/helpcenter/helpcenter_training/faq/index.rst @@ -27,4 +27,4 @@ Frequently Asked Questions how_and_where_should_we_submit_bugs_when_a_non-conformity_is_found_in_an_already_released_deployed_prod_documentation how_and_where_should_we_submit_bugs_when_the_documentation_url_is_wrong_the_link_is_not_working where_should_we_check_whether_a_document_related_bug_exists_or_not_for_our_components_if_a_customer_opens_it_or_it_is_coming_from_another_squad - how_to_create_a_gitea_account \ No newline at end of file + how_to_create_a_gitea_account diff --git a/doc/source/training/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst b/doc/source/helpcenter/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst rename to doc/source/helpcenter/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst diff --git a/doc/source/training/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst b/doc/source/helpcenter/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst similarity index 98% rename from doc/source/training/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst rename to doc/source/helpcenter/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst index cd2f6c1..bdc3299 100644 --- a/doc/source/training/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst +++ b/doc/source/helpcenter/helpcenter_training/faq/where_and_how_can_i_access_the_system_to_check_all_squad_components_and_the_current_tasks_or_raised_issues.rst @@ -24,7 +24,7 @@ There are multiple places based on source of the review task. All Gitea links ar There are multiple places based on source of the issue. All Gitea links are related to issues addressed to Huawei or Ecosystem squad and issues related to PREPROD doc portal -- https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/issues - general PREPROD docsportal issues +- https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/issues - general PREPROD docsportal issues - https://gitea.eco.tsi-dev.otc-service.com/docs/TARGET-SERVICE-NAME/issues - this is place for service based issue towards Huawei or Ecosystem squad for PREPROD for example https://gitea.eco.tsi-dev.otc-service.com/docs/resource-template-service/issues diff --git a/doc/source/training/helpcenter_training/faq/where_should_we_check_whether_a_document_related_bug_exists_or_not_for_our_components_if_a_customer_opens_it_or_it_is_coming_from_another_squad.rst b/doc/source/helpcenter/helpcenter_training/faq/where_should_we_check_whether_a_document_related_bug_exists_or_not_for_our_components_if_a_customer_opens_it_or_it_is_coming_from_another_squad.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/where_should_we_check_whether_a_document_related_bug_exists_or_not_for_our_components_if_a_customer_opens_it_or_it_is_coming_from_another_squad.rst rename to doc/source/helpcenter/helpcenter_training/faq/where_should_we_check_whether_a_document_related_bug_exists_or_not_for_our_components_if_a_customer_opens_it_or_it_is_coming_from_another_squad.rst diff --git a/doc/source/training/helpcenter_training/faq/which_stages_or_steps_should_be_performed_in_gitea_and_which_ones_in_github.rst b/doc/source/helpcenter/helpcenter_training/faq/which_stages_or_steps_should_be_performed_in_gitea_and_which_ones_in_github.rst similarity index 100% rename from doc/source/training/helpcenter_training/faq/which_stages_or_steps_should_be_performed_in_gitea_and_which_ones_in_github.rst rename to doc/source/helpcenter/helpcenter_training/faq/which_stages_or_steps_should_be_performed_in_gitea_and_which_ones_in_github.rst diff --git a/doc/source/training/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst b/doc/source/helpcenter/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst similarity index 94% rename from doc/source/training/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst rename to doc/source/helpcenter/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst index c1ab3ca..c15c846 100644 --- a/doc/source/training/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst +++ b/doc/source/helpcenter/helpcenter_training/faq/who_and_how_will_request_a_new_document_update_when_for_instance_a_new_feature_is_planned_to_be_released_for_a_component_in_the_next_delivery_cycle.rst @@ -6,8 +6,8 @@ Again multiple way how to request documentation update: - as a part of standard JIRA RM process there's task for Huawei (delivery documentation task) with mandatory field Documentation PR link which Huawei need to fill in with gitea link to be able to close the task. -- as a new issue in https://gitea.eco.tsi-dev.otc-service.com/docs/doc-exports/issues +- as a new issue in https://gitea.eco.tsi-dev.otc-service.com/docs/doc-exports/issues -- as a new issue in https://gitea.eco.tsi-dev.otc-service.com/docs/TARGET-SERVICE-NAME/issues +- as a new issue in https://gitea.eco.tsi-dev.otc-service.com/docs/TARGET-SERVICE-NAME/issues - email contact to Huawei R&D from this link: https://confluence.tsi-dev.otc-service.com/display/HUAW/Documentation+Gitops+Rollout+and+Status+page diff --git a/doc/source/training/helpcenter_training/index.rst b/doc/source/helpcenter/helpcenter_training/index.rst similarity index 92% rename from doc/source/training/helpcenter_training/index.rst rename to doc/source/helpcenter/helpcenter_training/index.rst index ae0ad48..16cdd8e 100644 --- a/doc/source/training/helpcenter_training/index.rst +++ b/doc/source/helpcenter/helpcenter_training/index.rst @@ -9,4 +9,4 @@ Helpcenter Training workflow difference_gitea_github contact - faq/index \ No newline at end of file + faq/index diff --git a/doc/source/training/helpcenter_training/introduction.rst b/doc/source/helpcenter/helpcenter_training/introduction.rst similarity index 94% rename from doc/source/training/helpcenter_training/introduction.rst rename to doc/source/helpcenter/helpcenter_training/introduction.rst index 4d255e4..b768b35 100644 --- a/doc/source/training/helpcenter_training/introduction.rst +++ b/doc/source/helpcenter/helpcenter_training/introduction.rst @@ -3,7 +3,7 @@ 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 +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: - Openness @@ -13,7 +13,7 @@ based on GitOps are introduced with following benefits: - Documentation as a 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 -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 to see the complete history of changes tracked by git itself. @@ -43,8 +43,8 @@ HC3.0 comes with the following features: - Search functionality - Mobile-ready UI layout - Report issue functionality directly on any page -- Suggest documentation fix functionality -- Consolidation of extra content like blueprints, tools, and libraries for developers +- Suggest documentation fix functionality +- Consolidation of extra content like blueprints, tools, and libraries for developers - One repository represents one cloud service - Each squad can control and manage their documentation independently - Automatization and check jobs across whole documentation lifecycle (from import to release) diff --git a/doc/source/training/helpcenter_training/training_images/helpcenter_3.0_process.drawio.png b/doc/source/helpcenter/helpcenter_training/training_images/helpcenter_3.0_process.drawio.png similarity index 100% rename from doc/source/training/helpcenter_training/training_images/helpcenter_3.0_process.drawio.png rename to doc/source/helpcenter/helpcenter_training/training_images/helpcenter_3.0_process.drawio.png diff --git a/doc/source/training/helpcenter_training/training_images/helpcenter_3.0_process_1.3.xml b/doc/source/helpcenter/helpcenter_training/training_images/helpcenter_3.0_process_1.3.xml similarity index 100% rename from doc/source/training/helpcenter_training/training_images/helpcenter_3.0_process_1.3.xml rename to doc/source/helpcenter/helpcenter_training/training_images/helpcenter_3.0_process_1.3.xml diff --git a/doc/source/training/helpcenter_training/workflow.rst b/doc/source/helpcenter/helpcenter_training/workflow.rst similarity index 100% rename from doc/source/training/helpcenter_training/workflow.rst rename to doc/source/helpcenter/helpcenter_training/workflow.rst diff --git a/doc/source/helpcenter/index.rst b/doc/source/helpcenter/index.rst new file mode 100644 index 0000000..8d470d6 --- /dev/null +++ b/doc/source/helpcenter/index.rst @@ -0,0 +1,9 @@ +================================= +Helpcenter Internal Documentation +================================= + +.. toctree:: + :maxdepth: 2 + + hc_ops/index + helpcenter_training/index diff --git a/doc/source/index.rst b/doc/source/index.rst index 4b44b49..2393a59 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,10 @@ Internal Documentation ====================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - training/index - cpn/index - otcdocstheme/index \ No newline at end of file + APImon + Status Dashboard + Helpcenter + Circle Partner Navigator + otcdocstheme diff --git a/doc/source/otcdocstheme/index.rst b/doc/source/otcdocstheme/index.rst index 76427a7..20427da 100644 --- a/doc/source/otcdocstheme/index.rst +++ b/doc/source/otcdocstheme/index.rst @@ -3,7 +3,7 @@ otcdocstheme Documentation ========================== .. toctree:: - :maxdepth: 1 + :maxdepth: 1 updating_the_theme parsed_confpy_settings diff --git a/doc/source/status_dashboard/index.rst b/doc/source/status_dashboard/index.rst new file mode 100644 index 0000000..e6f4fce --- /dev/null +++ b/doc/source/status_dashboard/index.rst @@ -0,0 +1,8 @@ +======================================= +Status Dashboard Internal Documentation +======================================= + +.. toctree:: + :maxdepth: 2 + + sd2_training/index diff --git a/doc/source/training/sd2_training/contact.rst b/doc/source/status_dashboard/sd2_training/contact.rst similarity index 95% rename from doc/source/training/sd2_training/contact.rst rename to doc/source/status_dashboard/sd2_training/contact.rst index 8552d03..f7c1be6 100644 --- a/doc/source/training/sd2_training/contact.rst +++ b/doc/source/status_dashboard/sd2_training/contact.rst @@ -18,4 +18,4 @@ If there is another general issue/demand/request try to locate proper repository https://github.com/orgs/stackmon/repositories For general questions you can write an E-Mail to the `Ecosystems Squad -`_. \ No newline at end of file +`_. diff --git a/doc/source/training/sd2_training/dashboards.rst b/doc/source/status_dashboard/sd2_training/dashboards.rst similarity index 99% rename from doc/source/training/sd2_training/dashboards.rst rename to doc/source/status_dashboard/sd2_training/dashboards.rst index 0ef681d..26ad64a 100644 --- a/doc/source/training/sd2_training/dashboards.rst +++ b/doc/source/status_dashboard/sd2_training/dashboards.rst @@ -71,7 +71,7 @@ and visualize it in: - API calls duration per each URL query. - API calls duration (aggregated). - API calls response codes. - + Example at https://dashboard.tsi-dev.otc-service.com/d/b4560ed6-95f0-45c0-904c-6ff9f8a491e8/sfs-service-statistics?orgId=1&refresh=10s .. image:: training_images/cloud_service_statistics.png @@ -97,4 +97,4 @@ without any restrictions. This approach is valid for testing proofs of concept, temporary solutions, and investigations but should not be used as permanent solution as customized dashboards which are not properly stored on Github repositories -might be permanently deleted in case of full dashboard service re-installation. \ No newline at end of file +might be permanently deleted in case of full dashboard service re-installation. diff --git a/doc/source/training/sd2_training/databases.rst b/doc/source/status_dashboard/sd2_training/databases.rst similarity index 98% rename from doc/source/training/sd2_training/databases.rst rename to doc/source/status_dashboard/sd2_training/databases.rst index 42ea16e..fe1dc54 100644 --- a/doc/source/training/sd2_training/databases.rst +++ b/doc/source/status_dashboard/sd2_training/databases.rst @@ -14,7 +14,7 @@ cloudmon database ================= -EpMon data are stored in the clustered Graphite TSDB. +EpMon data are stored in the clustered Graphite TSDB. Metrics emitted by the processes are gathered in the row of statsd processes which aggregate metrics to 10s precision. @@ -86,7 +86,7 @@ cloudmon-metrics database ========================= -Cloudmon data are stored in the clustered Graphite TSDB. +Cloudmon data are stored in the clustered Graphite TSDB. Metrics are emitted by the Metric Processor. Metric Processor is processing the cloudmon metrics (from EpMon) and based on defined flag metrics (https://github.com/opentelekomcloud-infra/stackmon-config/blob/main/mp-prod/conf.d/flag_metrics.yaml) and defined thresholds(https://github.com/opentelekomcloud-infra/stackmon-config/blob/main/mp-prod/conf.d/metric_templates.yaml) finally produces the health metrics @@ -157,4 +157,4 @@ Health metrics contain following values: - 0 - Service operates normally - 1 - Service has a minor issue resulting from defined reached flag metric(s) -- 2 - Service has an outage resulting from defined reached flag metrics(s) \ No newline at end of file +- 2 - Service has an outage resulting from defined reached flag metrics(s) diff --git a/doc/source/training/sd2_training/epmon_checks.rst b/doc/source/status_dashboard/sd2_training/epmon_checks.rst similarity index 99% rename from doc/source/training/sd2_training/epmon_checks.rst rename to doc/source/status_dashboard/sd2_training/epmon_checks.rst index 8d6abca..43d1289 100644 --- a/doc/source/training/sd2_training/epmon_checks.rst +++ b/doc/source/status_dashboard/sd2_training/epmon_checks.rst @@ -64,7 +64,7 @@ for the Swisscloud): service_type: asv1 urls: [] -There are three separate items defined for the autoscaling service: +There are three separate items defined for the autoscaling service: - The ``as`` entry is the default. It is used for the public OTC regions. - The ``as_swiss`` entry defines the specific settings for the Swisscloud. @@ -92,4 +92,4 @@ the OTC service catalog) is not being triggered by EpMon at all as it contains an empty ``urls`` list. Collected response codes and response times are sent to the Graphite time -series database for further processing by the Metrics Processor. \ No newline at end of file +series database for further processing by the Metrics Processor. diff --git a/doc/source/training/sd2_training/incidents.rst b/doc/source/status_dashboard/sd2_training/incidents.rst similarity index 99% rename from doc/source/training/sd2_training/incidents.rst rename to doc/source/status_dashboard/sd2_training/incidents.rst index a03bb8f..3aa4ce2 100644 --- a/doc/source/training/sd2_training/incidents.rst +++ b/doc/source/status_dashboard/sd2_training/incidents.rst @@ -65,4 +65,4 @@ Every closed incident is recorded in the Incident History. Incident notifications ====================== -Status Dashboard support RSS feeds for incident notifications. The details how to setup RSS feed are described on :ref:`notifications ` page. \ No newline at end of file +Status Dashboard support RSS feeds for incident notifications. The details how to setup RSS feed are described on :ref:`notifications ` page. diff --git a/doc/source/training/sd2_training/index.rst b/doc/source/status_dashboard/sd2_training/index.rst similarity index 100% rename from doc/source/training/sd2_training/index.rst rename to doc/source/status_dashboard/sd2_training/index.rst diff --git a/doc/source/training/sd2_training/introduction.rst b/doc/source/status_dashboard/sd2_training/introduction.rst similarity index 96% rename from doc/source/training/sd2_training/introduction.rst rename to doc/source/status_dashboard/sd2_training/introduction.rst index 2c1bef5..98fc2e0 100644 --- a/doc/source/training/sd2_training/introduction.rst +++ b/doc/source/status_dashboard/sd2_training/introduction.rst @@ -5,7 +5,7 @@ Introduction to the Status Dashboard 2 The Open Telekom Cloud is represented to users and customers by the API endpoints and the various services behind them. Customers are interested in a reliable way to check and verify if those services are actually -available to them via the Internet. +available to them via the Internet. The Status Dashboard 2 (SD2) is a service facility monitoring of all OTC services, intended for customers to grasp a quick overview of the service @@ -28,8 +28,8 @@ Key features of the SD2 framework: - Developed to **supervise the 24/7 availability** of the public APIs of the OTC platform. - SD2 **sends GET-requests that list resources** to API-endoints. It - does explicitly not simulate more complex, multi-stage use-cases. - - Answers to such requests (status, roundtrip time) are grouped by + does explicitly not simulate more complex, multi-stage use-cases. + - Answers to such requests (status, roundtrip time) are grouped by **service** and considered as **metrics**. They are sent to the **Metric Processor**. - The Metric Processor maps the metrics to **flags**, that are raised @@ -80,7 +80,7 @@ SD2 comes with the following features: - HTTP GET-requests for Endpoint Monitoring. - Custom metrics and custom thresholds. - Incidents are generated once non-green semaphores are detected. - Alternatively, incidents can be raised manually as maintence + Alternatively, incidents can be raised manually as maintence downtimes. - All OTC-environments including eu-de, eu-nl, and eu-sc2 are covered. - The monitoring environments are decoupled from the monitoring zones @@ -90,4 +90,4 @@ SD2 comes with the following features: - Each service squad can control and manage their metrics as well as dashboards individually. - All parameters configured from single place (stackmon-config) in - human readable form (YAML). \ No newline at end of file + human readable form (YAML). diff --git a/doc/source/training/sd2_training/metrics.rst b/doc/source/status_dashboard/sd2_training/metrics.rst similarity index 99% rename from doc/source/training/sd2_training/metrics.rst rename to doc/source/status_dashboard/sd2_training/metrics.rst index 45e633f..de2da89 100644 --- a/doc/source/training/sd2_training/metrics.rst +++ b/doc/source/status_dashboard/sd2_training/metrics.rst @@ -7,8 +7,7 @@ Metrics Status Dashboard distinguish 2 types of metrics: - Metrics emitted by EpMon -- Metrics by Metrics Processor - +- Metrics by Metrics Processor - The EpMON plugin internally invokes method calls to **OpenStack SDK libraries.** They in turn generate metrics about each API call they do. This @@ -36,7 +35,7 @@ Status Dashboard distinguish 2 types of metrics: Custom metrics: Besides default flag and health metrics some services might require specific approach -and evaluation of how to aggregate and combine the HTTP query metrics and +and evaluation of how to aggregate and combine the HTTP query metrics and whether custom thresholds must be applied. For such cases, the custom metrics might be introduced in Metric Processor configuration files: https://github.com/opentelekomcloud-infra/stackmon-config/tree/main/mp-prod/conf.d diff --git a/doc/source/training/sd2_training/monitoring_coverage.rst b/doc/source/status_dashboard/sd2_training/monitoring_coverage.rst similarity index 98% rename from doc/source/training/sd2_training/monitoring_coverage.rst rename to doc/source/status_dashboard/sd2_training/monitoring_coverage.rst index e86a963..af89ba9 100644 --- a/doc/source/training/sd2_training/monitoring_coverage.rst +++ b/doc/source/status_dashboard/sd2_training/monitoring_coverage.rst @@ -182,7 +182,7 @@ Example configuration of the monitoring matrix and covered services: - volume Note that Service Managers or Engineers usually don't need to -touch this configuration. Details should be negotiated with +touch this configuration. Details should be negotiated with Platform Engineers. The attribute ``env`` defines the target for monitoring (which @@ -208,4 +208,4 @@ Playbooks are stored on GitHub at: The EpMon plugin defines which service entries are used in which specific environment. Services not present in an environment -won't have entry in this config as well, respectively. \ No newline at end of file +won't have entry in this config as well, respectively. diff --git a/doc/source/training/sd2_training/notifications.rst b/doc/source/status_dashboard/sd2_training/notifications.rst similarity index 100% rename from doc/source/training/sd2_training/notifications.rst rename to doc/source/status_dashboard/sd2_training/notifications.rst diff --git a/doc/source/training/sd2_training/onepager.rst b/doc/source/status_dashboard/sd2_training/onepager.rst similarity index 100% rename from doc/source/training/sd2_training/onepager.rst rename to doc/source/status_dashboard/sd2_training/onepager.rst diff --git a/doc/source/training/sd2_training/recorded_session.rst b/doc/source/status_dashboard/sd2_training/recorded_session.rst similarity index 100% rename from doc/source/training/sd2_training/recorded_session.rst rename to doc/source/status_dashboard/sd2_training/recorded_session.rst diff --git a/doc/source/training/sd2_training/status_dashboard_frontend.rst b/doc/source/status_dashboard/sd2_training/status_dashboard_frontend.rst similarity index 98% rename from doc/source/training/sd2_training/status_dashboard_frontend.rst rename to doc/source/status_dashboard/sd2_training/status_dashboard_frontend.rst index 5bc962f..aea5038 100644 --- a/doc/source/training/sd2_training/status_dashboard_frontend.rst +++ b/doc/source/status_dashboard/sd2_training/status_dashboard_frontend.rst @@ -17,7 +17,7 @@ across all configured regions. It supports these features: - Incident data is available through an API. - RSS notification (for the OTC mobile app and other integrations). - SLA view of the services. -- Incident history. +- Incident history. Two Status Dashboard portals are available: @@ -71,4 +71,4 @@ SLA view https://status.cloudmon.eco.tsi-dev.otc-service.com/sla is calculated o .. image:: training_images/sd2_sla.jpg -Details how to work with incidents are described on the :ref:`incidents ` page. \ No newline at end of file +Details how to work with incidents are described on the :ref:`incidents ` page. diff --git a/doc/source/training/sd2_training/training_images/cloud_service_statistics.png b/doc/source/status_dashboard/sd2_training/training_images/cloud_service_statistics.png similarity index 100% rename from doc/source/training/sd2_training/training_images/cloud_service_statistics.png rename to doc/source/status_dashboard/sd2_training/training_images/cloud_service_statistics.png diff --git a/doc/source/training/sd2_training/training_images/flag_and_health_dashboard.png b/doc/source/status_dashboard/sd2_training/training_images/flag_and_health_dashboard.png similarity index 100% rename from doc/source/training/sd2_training/training_images/flag_and_health_dashboard.png rename to doc/source/status_dashboard/sd2_training/training_images/flag_and_health_dashboard.png diff --git a/doc/source/training/sd2_training/training_images/graphite_query.png b/doc/source/status_dashboard/sd2_training/training_images/graphite_query.png similarity index 100% rename from doc/source/training/sd2_training/training_images/graphite_query.png rename to doc/source/status_dashboard/sd2_training/training_images/graphite_query.png diff --git a/doc/source/training/sd2_training/training_images/mp_query.png b/doc/source/status_dashboard/sd2_training/training_images/mp_query.png similarity index 100% rename from doc/source/training/sd2_training/training_images/mp_query.png rename to doc/source/status_dashboard/sd2_training/training_images/mp_query.png diff --git a/doc/source/training/sd2_training/training_images/sd2_data_flow.svg b/doc/source/status_dashboard/sd2_training/training_images/sd2_data_flow.svg similarity index 100% rename from doc/source/training/sd2_training/training_images/sd2_data_flow.svg rename to doc/source/status_dashboard/sd2_training/training_images/sd2_data_flow.svg diff --git a/doc/source/training/sd2_training/training_images/sd2_frontend.jpg b/doc/source/status_dashboard/sd2_training/training_images/sd2_frontend.jpg similarity index 100% rename from doc/source/training/sd2_training/training_images/sd2_frontend.jpg rename to doc/source/status_dashboard/sd2_training/training_images/sd2_frontend.jpg diff --git a/doc/source/training/sd2_training/training_images/sd2_incident.jpg b/doc/source/status_dashboard/sd2_training/training_images/sd2_incident.jpg similarity index 100% rename from doc/source/training/sd2_training/training_images/sd2_incident.jpg rename to doc/source/status_dashboard/sd2_training/training_images/sd2_incident.jpg diff --git a/doc/source/training/sd2_training/training_images/sd2_sla.jpg b/doc/source/status_dashboard/sd2_training/training_images/sd2_sla.jpg similarity index 100% rename from doc/source/training/sd2_training/training_images/sd2_sla.jpg rename to doc/source/status_dashboard/sd2_training/training_images/sd2_sla.jpg diff --git a/doc/source/training/sd2_training/workflow.rst b/doc/source/status_dashboard/sd2_training/workflow.rst similarity index 97% rename from doc/source/training/sd2_training/workflow.rst rename to doc/source/status_dashboard/sd2_training/workflow.rst index 25ad8c8..95e8726 100644 --- a/doc/source/training/sd2_training/workflow.rst +++ b/doc/source/status_dashboard/sd2_training/workflow.rst @@ -27,4 +27,4 @@ SD2 Data Flow Process #. Grafana uses metrics and statistics databases as the data sources for the dashboards. The dashboard with various panels shows the real-time status of the platform. Grafana supports - also historical views and trends. \ No newline at end of file + also historical views and trends. diff --git a/doc/source/training/index.rst b/doc/source/training/index.rst deleted file mode 100644 index 1fc19ec..0000000 --- a/doc/source/training/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Trainings -========= - -.. toctree:: - :maxdepth: 1 - - helpcenter_training/index - apimon_training/index - sd2_training/index diff --git a/tox.ini b/tox.ini index 976f958..ae8a99f 100644 --- a/tox.ini +++ b/tox.ini @@ -13,6 +13,8 @@ commands = stestr run {posargs} stestr slowest [testenv:pep8] +allowlist_externals = + doc8 commands = doc8 doc/source README.rst