1
0
forked from docs/docsportal

add faq details

This commit is contained in:
Tino Schreiber 2023-02-15 11:47:13 +00:00
parent 25d4f6267f
commit b79d39200e
10 changed files with 29 additions and 6 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

View File

@ -2,4 +2,4 @@
How do we deal with Open tickets? May we have a separate session for that? 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.

View File

@ -2,4 +2,4 @@
How does the full document review workflow look like end-to-end on a high level? 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 <https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Process>`_ .

View File

@ -2,6 +2,26 @@
How to check the rendered HTML of the entire document in the browser (which button should I click on)? 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-<document-type>` 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

View File

@ -2,7 +2,10 @@
What are the exact locations where the documents can be found per each component? 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