diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_1.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_1.png new file mode 100644 index 0000000..6207a88 Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_1.png differ diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_2.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_2.png new file mode 100644 index 0000000..9f745cf Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_2.png differ diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_3.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_3.png new file mode 100644 index 0000000..9e78b2b Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_3.png differ diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_4.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_4.png new file mode 100644 index 0000000..307e6e9 Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_4.png differ diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_5.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_5.png new file mode 100644 index 0000000..577a1e3 Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_5.png differ diff --git a/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_6.png b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_6.png new file mode 100644 index 0000000..0cb081f Binary files /dev/null and b/doc/source/internal/helpcenter_training/faq/faq_images/html_preview_6.png differ diff --git a/doc/source/internal/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst b/doc/source/internal/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst index f6a685b..87ca986 100644 --- a/doc/source/internal/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst +++ b/doc/source/internal/helpcenter_training/faq/how_do_we_deal_with_open_tickets_may_we_have_a_separate_session_for_that.rst @@ -2,4 +2,4 @@ How do we deal with Open tickets? May we have a separate session for that? ========================================================================== - Process squad has been asked to move all open tickets to Ecosystem squad. Most of them are already solved or obsolete. +Requested squad has been asked to move all open tickets to Ecosystem squad. Most of them are already solved or obsolete. diff --git a/doc/source/internal/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst b/doc/source/internal/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst index 9e0958e..7e82c99 100644 --- a/doc/source/internal/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst +++ b/doc/source/internal/helpcenter_training/faq/how_does_the_full_document_review_workflow_look_like_end-to-end_on_a_high_level.rst @@ -2,4 +2,4 @@ How does the full document review workflow look like end-to-end on a high level? ================================================================================ -link to process +The process of the Documentation Change Process under the following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Process `_ . diff --git a/doc/source/internal/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/internal/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst index 490bd90..106e21c 100644 --- a/doc/source/internal/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/internal/helpcenter_training/faq/how_to_check_the_rendered_html_of_the_entire_document_in_the_browser_which_button_should_i_click_on.rst @@ -2,6 +2,26 @@ How to check the rendered HTML of the entire document in the browser (which button should I click on)? ====================================================================================================== -In the document PR (for example https://gitea.eco.tsi-dev.otc-service.com/docs/resource-template-service/pulls) search for the latest documentation check job result (for example build-otc-umn) if it's older than one week please add comment in PR "recheck" which will trigger new check jobs and will pre-render documentation again. If it's actual (not older than one week) click on the job, then click on artifacts then click on docs preview site and you should appear on pre-rendered HTML documentation. +**1) Open the PullRequest (PR) of the prefered document.** -**service doc PR -> Conversation -> build jobs (build-otc-api-ref, build-otc-umn, otc-tox-docs) -> Artifacts -> Docs preview site -> choose doc type -> HTML** +.. image:: faq_images/html_preview_1.png + +**2) Click on the `Conversation` tab and scroll down.** + +.. image:: faq_images/html_preview_2.png + +**3) Choose the link on `build-otc-` or the `Details` link on the Zuul Check-Job.** + +.. image:: faq_images/html_preview_3.png + +**4) The Zuul dashboards opens. Under the `Artifacts` tab the `Docs preview site` can be chosen.** + +.. image:: faq_images/html_preview_4.png + +**5) Sometimes a file structure opens, choose the document type.** + +.. image:: faq_images/html_preview_5.png + +**6) The preview site opens.** + +.. image:: faq_images/html_preview_6.png diff --git a/doc/source/internal/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst b/doc/source/internal/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst index 7c7d3e1..6d60595 100644 --- a/doc/source/internal/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst +++ b/doc/source/internal/helpcenter_training/faq/what_are_the_exact_locations_where_the_documents_can_be_found_per_each_component.rst @@ -2,7 +2,10 @@ What are the exact locations where the documents can be found per each component? ================================================================================= +**PreProd-Environment (Gitea):** - https://gitea.eco.tsi-dev.otc-service.com/org/docs/teams/docs-orchestration-rw/repositories +* https://gitea.eco.tsi-dev.otc-service.com/org/docs/teams/docs-orchestration-rw/repositories - https://github.com/orgs/opentelekomcloud-docs/teams/docs-orchestration-rw/repositories +**Prod-Environment (GitHub):** + +* https://github.com/orgs/opentelekomcloud-docs/teams/docs-orchestration-rw/repositories