diff --git a/doc/source/_static/images/added_new_text.png b/doc/source/_static/images/added_new_text.png new file mode 100755 index 0000000..040243c Binary files /dev/null and b/doc/source/_static/images/added_new_text.png differ diff --git a/doc/source/_static/images/compare_commits.png b/doc/source/_static/images/compare_commits.png new file mode 100755 index 0000000..2ed6159 Binary files /dev/null and b/doc/source/_static/images/compare_commits.png differ diff --git a/doc/source/_static/images/compare_images.png b/doc/source/_static/images/compare_images.png new file mode 100755 index 0000000..37fa2ff Binary files /dev/null and b/doc/source/_static/images/compare_images.png differ diff --git a/doc/source/_static/images/compare_text.png b/doc/source/_static/images/compare_text.png new file mode 100755 index 0000000..7c95074 Binary files /dev/null and b/doc/source/_static/images/compare_text.png differ diff --git a/doc/source/_static/images/jira_document_pr_link.png b/doc/source/_static/images/jira_document_pr_link.png new file mode 100755 index 0000000..b32cba5 Binary files /dev/null and b/doc/source/_static/images/jira_document_pr_link.png differ diff --git a/doc/source/internal/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/internal/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 index 257fb8c..8f571a4 100644 --- a/doc/source/internal/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/internal/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 @@ -3,3 +3,5 @@ How can we accept the entire document when we are fine with it? Who will have th ==================================================================================================================== See the last option in :ref:`Previous question `. This can be delegated to different person chosen by squad. + +Also please refer for more details in :ref:`general change process flow `. 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 7e82c99..13df8f7 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 @@ -3,3 +3,6 @@ How does the full document review workflow look like end-to-end on a high level? ================================================================================ The process of the Documentation Change Process under the following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Process `_ . + +The more detailed description of the QA/UAT document review under the following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Review `_ . + diff --git a/doc/source/internal/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/internal/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 index 2b3e049..15aa939 100644 --- a/doc/source/internal/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/internal/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 @@ -2,4 +2,7 @@ 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? ====================================================================================================================================== -Huawei is responsible to do that in Huawei Documentation Delivery task in RM +Huawei is responsible to provide link to Gitea pull request in Huawei Documentation Delivery task in RM: + +.. figure:: /_static/images/jira_document_pr_link.png + diff --git a/doc/source/internal/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst b/doc/source/internal/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst index 8f43244..783b67f 100644 --- a/doc/source/internal/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst +++ b/doc/source/internal/helpcenter_training/faq/how_to_add_a_comment_for_a_text_or_an_image.rst @@ -4,4 +4,11 @@ How to add a comment for a text or an image? As natively in Gitea/Github any change in PR can be raised as a comment and can become subject for requesting the change +Adding a comment is a simple thing as described on the following link: `https://gitea.eco.tsi-dev.otc-service.com/docs/docsportal/wiki/Review#adding_comments `_ . + +Adding a comment for an image is not possible directly as shown on previous link but can be done simply at Conversation tab. + In case you want to comment something not being subject of change in PR but still valuable to comment (other part of documentation) you can raise an issue for that. + + + diff --git a/doc/source/internal/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst b/doc/source/internal/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst index 4302100..bd4ca82 100644 --- a/doc/source/internal/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst +++ b/doc/source/internal/helpcenter_training/faq/how_to_compare_the_content_of_a_change_with_the_base_modified_text_images.rst @@ -1,7 +1,21 @@ -============================================================================= -How to compare the content of a change with the base (modified text/images)? -============================================================================= +============================================================================ +How to compare the content of a change with the base (modified text/images)? +============================================================================ -Gitea/Github natively support the comparison between the diffs and new PR is nothing else just a diff to a base. Additionally in case of upcoming next commits in existing PR (follow-up updates from Huawei based on QA/UAT reviews) you can see even differences between the commits of the same PR. It means seeing latest changes from Huawei against previous changes in same PR. +Gitea/Github natively support the comparison between the diffs and new PR is nothing else just a diff to a base. Text comparison is represented as a "red" (removals) and "green" (addons) highlighted changes as shown on the image below: + +.. figure:: /_static/images/compare_text.png + +Image comparison offers multiple options how to visualize changes. The most common is side by side comparison: + +.. figure:: /_static/images/compare_images.png + +In case there are only added changes or the whole new files are added then the whole file is highlighted by green color: + +.. figure:: /_static/images/added_new_text.png + + +Gitea/Github also natively support comparison changes between the multiple commits inside of the single pull request. For example follow-up updates from Huawei based on QA/UAT reviews are represented as multiple commits in same PR. The differences between the commits can be seen by clicking on the respecitve commit which will show the differences against the previous commit. + +.. figure:: /_static/images/compare_commits.png -Images are also shown side by side in case of changes for easy comparison. diff --git a/doc/source/internal/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/internal/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 45b1f7c..a8635d8 100644 --- a/doc/source/internal/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/internal/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 @@ -9,3 +9,6 @@ After finishing the review (and raising the comments) you have 3 options how to - **Comment** - Raising the comments without explicit requirement of any changes (not blocking approval) - **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 `_ . + diff --git a/doc/source/internal/helpcenter_training/workflow.rst b/doc/source/internal/helpcenter_training/workflow.rst index 3f71804..61af7cd 100644 --- a/doc/source/internal/helpcenter_training/workflow.rst +++ b/doc/source/internal/helpcenter_training/workflow.rst @@ -1,3 +1,4 @@ +.. _documentation_change_process: Documentation Change Process ============================