forked from docs/docsportal
Compare commits
6 Commits
vhasko-pat
...
main
Author | SHA1 | Date | |
---|---|---|---|
ffc27f2494 | |||
ec7ca5950f | |||
7e9fac0fb1 | |||
22e3c2a594 | |||
c90518331b | |||
7da187b6f0 |
@ -47,3 +47,12 @@
|
||||
.navigator-container .card li {
|
||||
padding: 0.2rem 1rem;
|
||||
}
|
||||
|
||||
/* A "nice" workaround to let us keep l2 level permanently open
|
||||
* but hide child ul's not underneath current selection.
|
||||
* The only eventually open issue is that this way the whole child tree is
|
||||
* open including all subtrees.
|
||||
*/
|
||||
.docs-sidebar-toc li.toctree-l2:not(.current) > ul {
|
||||
display: none;
|
||||
}
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 186 KiB |
18
doc/source/internal/helpcenter_training/context.rst
Normal file
18
doc/source/internal/helpcenter_training/context.rst
Normal file
@ -0,0 +1,18 @@
|
||||
Context - Whom to address for Feedback?
|
||||
=======================================
|
||||
|
||||
In case you have any feedback, proposals or found any issues regarding the HelpCenter 3.0, you can address them in the corresponding GitHub or Gitea repositories.
|
||||
|
||||
Issues or feedback regarding the **internal Helpcenter** as well as new feature requests can be addressed by filing an issue on the internal **Gitea** repository under https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/issues
|
||||
|
||||
If a documentation to a service is missing, please open a ticket on the doc-exports repository: https://gitea.eco.tsi-dev.otc-service.com/docs/doc-exports/issues
|
||||
|
||||
If you have found any problems which affects the **production Helpcenter** please instead open an issue on **GitHub**.
|
||||
|
||||
- In case it is a general issue, create it in the docsportal repository: https://github.com/opentelekomcloud-docs/docsportal/issues
|
||||
- If you have found anything wrong regarding a specific documentation, please open an issue on the corresponding repository under opentelekomcloud-docs. For example, on ECS you can open an issue here: https://github.com/opentelekomcloud-docs/elastic-cloud-server/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>`_.
|
@ -0,0 +1,11 @@
|
||||
==============================
|
||||
How to create a Gitea account?
|
||||
==============================
|
||||
|
||||
To create a Gitea account, just click on Log-In in the top-right corner of the landing page. Then simply Log-In with your OTC-LDAP credentials.
|
||||
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 <mailto:dl-pbcotcdeleco@t-systems.com>`_.
|
||||
|
||||
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.
|
@ -27,3 +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
|
@ -8,4 +8,5 @@ Helpcenter Training
|
||||
introduction
|
||||
workflow
|
||||
difference_gitea_github
|
||||
context
|
||||
faq/index
|
Binary file not shown.
Before Width: | Height: | Size: 478 KiB After Width: | Height: | Size: 506 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -29,11 +29,7 @@ Document Change Process Description
|
||||
8) Assigned squad member(s) start the review process of the auto-created Pull Request and communicate their feedback. This can be done via the included functionality of Gitea to provide comments to a specific line of code.
|
||||
9) If the Pull Request fullfils all expectations, the Pull Request will be approved by the reviewer via ``Approve`` selection and the steps 10 and 11 can be skipped. The Pull Request is marked as ``approved``.
|
||||
10) The Pull Request does not fullfil all expectations and review comments needs to be added to the specific lines of code in the target repository of the specific service. After all comments are placed, the review of the Pull Request must be finished with ``Request changes`` selection instead of ``Approve``.
|
||||
11) Huawei collects comments and prepare new documentation change or reply to the comments. There are two possible options to go further:
|
||||
|
||||
a. Huawei member uses the comments to prepare a new documentation delivery from the beginning (out of Huawei documentation system). The whole process starts from the beginning.
|
||||
b. Changes are made directly in the Pull Request. The changes are tracked by the Huawei employee and changed in the Huawei documentation system afterwards.
|
||||
|
||||
11) Huawei collects comments and prepare new documentation change or reply to the comments. They update existing Pull Request with new commit on docs/doc-exports repository.
|
||||
12) After the review has been approved, the Squads product owner or a privileged squad member can add the ``gate`` label to the Pull Request.
|
||||
13) The ``gate`` label triggers another CI/CD pipeline of Zuul to render the final PreProd documentation on https://docs-int.otc-service.com/.
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
{%- if theme_sidebar_mode == 'toc' %}
|
||||
{{ toc }}
|
||||
{%- elif theme_sidebar_mode == 'toctree' %}
|
||||
{{ toctree(maxdepth=2,includehidden=True, collapse=False) }}
|
||||
{{ toctree(maxdepth=3, includehidden=True, collapse=False, titles_only=True) }}
|
||||
{%- endif %}
|
||||
</div>
|
||||
{%- endif %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user