diff --git a/doc/source/training/helpcenter_training/faq/faq_images/check_approve_gate.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/check_approve_gate.png similarity index 100% rename from doc/source/training/helpcenter_training/faq/faq_images/check_approve_gate.png rename to doc/source/helpcenter/helpcenter_training/faq/faq_images/check_approve_gate.png diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/commit_changes.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/commit_changes.png new file mode 100644 index 0000000..a9546a0 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/commit_changes.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_changes.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_changes.png new file mode 100644 index 0000000..5862467 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_changes.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_pull_request.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_pull_request.png new file mode 100644 index 0000000..28ab358 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/compare_pull_request.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_1.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_1.png new file mode 100644 index 0000000..454106d Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_1.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_2.png new file mode 100644 index 0000000..148c1f6 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/create_github_fork_2.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/delete_branch.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/delete_branch.png new file mode 100644 index 0000000..e9f7877 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/delete_branch.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_conf_py.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_conf_py.png new file mode 100644 index 0000000..700817d Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_conf_py.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_index_rst.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_index_rst.png new file mode 100644 index 0000000..e0fd683 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/edit_index_rst.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request.png new file mode 100644 index 0000000..ae8f44e Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png new file mode 100644 index 0000000..ae8f44e Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png new file mode 100644 index 0000000..4191a3a Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png new file mode 100644 index 0000000..e0b2537 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch.png new file mode 100644 index 0000000..73ea6df Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch2.png new file mode 100644 index 0000000..5efddf3 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_new_branch2.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_sync_fork.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_sync_fork.png new file mode 100644 index 0000000..6cce6a1 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/github_sync_fork.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/infra_otc_metadata.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/infra_otc_metadata.png new file mode 100644 index 0000000..e382075 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/infra_otc_metadata.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request.png new file mode 100644 index 0000000..ae8f44e Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request2.png new file mode 100644 index 0000000..4191a3a Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request2.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png new file mode 100644 index 0000000..e0b2537 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/otc_metadata_update.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/otc_metadata_update.png new file mode 100644 index 0000000..e382075 Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/otc_metadata_update.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/propose_file_change.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/propose_file_change.png new file mode 100644 index 0000000..613d71f Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/propose_file_change.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview.png new file mode 100644 index 0000000..459ad9b Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview2.png b/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview2.png new file mode 100644 index 0000000..46a245c Binary files /dev/null and b/doc/source/helpcenter/helpcenter_training/faq/faq_images/storage_component_overview2.png differ diff --git a/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_component_page.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_component_page.rst new file mode 100644 index 0000000..14e4830 --- /dev/null +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_component_page.rst @@ -0,0 +1,94 @@ +============================ +How to update component page +============================ + +**Goal** + +Mark service as depricated + +.. image:: training_images/storage_component_overview2.png + :target: training_images/storage_component_overview2.png + :alt: storage_component_overview + + +1)**Create fork on github** + +You need to create fork only in case you don’t have existing already + +.. image:: training_images/create_github_fork_1.png + :target: training_images/create_github_fork_1.png + :alt: create_fork_1 + +Choose your name as owner + +.. image:: training_images/create_github_fork_2.png + :target: training_images/create_github_fork_2.png + :alt: create_fork_2 + +2)**In case you have existing fork** + +You need to sync your fork with main. Then go to branches. + +.. image:: training_images/github_sync_fork.png + :target: training_images/github_sync_fork.png + :alt: sync_fork + +3)**Create new branch** + +.. image:: training_images/github_new_branch.png + :target: training_images/github_new_branch.png + :alt: new_branch + +Add new branch name: + +.. image:: training_images/github_new_branch2.png + :target: training_images/github_new_branch2.png + :alt: new_branch2 + +4)**Edit index.rst** + +.. image:: training_images/edit_index_rst.png + :target: training_images/edit_index_rst.png + :alt: edit_index.rst + +5)**Edit conf.py ** + +.. image:: training_images/edit_conf_py.png + :target: training_images/edit_conf_py.png + :alt: edit_conf_py + +6)**Commit changes** + +Once you finish with editing of pages click commit changes. + +.. image:: training_images/commit_changes.png + :target: training_images/commit_changes.png + :alt: commit_changes + +7)**Compare & pull request** + +.. image:: training_images/compare_pull_request.png + :target: training_images/compare_pull_request.png + :alt: compare_changes + +8)**Comparing changes** + +Check correct source and target pull request and branch. Then create pull request. + +.. image:: training_images/compare_changes.png + :target: training_images/compare_changes.png + :alt: compare_changes2 + +9)**Wait for checks, approve and gate** + +.. image:: training_images/check_approve_gate.png + :target: training_images/check_approve_gate.png + :alt: check_approve_gate + +10)**Delete branch** + +After successful merge delete branch. + +.. image:: training_images/delete_branch.png + :target: training_images/delete_branch.png + :alt: delete_branch diff --git a/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_landing_page.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_landing_page.rst new file mode 100644 index 0000000..9f821c9 --- /dev/null +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_landing_page.rst @@ -0,0 +1,89 @@ +============================= +How to update landing page +============================= + +**Goal** + +Mark service as depricated + +.. image:: training_images/storage_component_overview.png + :target: training_images/storage_component_overview.png + :alt: storage_component_overview + +1)**Create fork on gitea** + +You need to create fork only in case you don’t have existing already + +.. image:: traininig_images/infra_otc_metadata.png + :target: traininig_images/infra_otc_metadata.png + :alt: infra_otc_metadata + +https://gitea.eco.tsi-dev.otc-service.com/marmulle/otc-metadata/src/branch/main/otc_metadata/data/documents + +2)**Sync fork** + +Sync work with main currently do not support sync in console and you need to do it manually. + +- you need to configure .ssh/config.ssh/config + +.. code-block:: text + + Host gitea.eco.tsi-dev.otc-service.com + User git + Port 2222 + HostName gitea.eco.tsi-dev.otc-service.com + IdentityFile ~/.ssh/id_rsa + +You should be able to ssh gitea and get You've successfully authenticated message. + +.. code-block:: text + + ssh gitea.eco.tsi-dev.otc-service.com + +Clone your branch, not main: + +.. code-block:: text + + git clone ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/marmulle/otc-metadata.git + +Then follow instructions to recover fork: https://gitea.eco.tsi-dev.otc-service.com/docs/doc-exports/wiki/Recovering-Fork + +3)**Update necessary file** + +In this case I was updating obs-swiftapi.yaml located in https://gitea.eco.tsi-dev.otc-service.com/marmulle/otc-metadata/src/branch/main/otc_metadata/data/documents + +4)**Propose file changes** + +After update file propose file changes. Name of branch or pull request should be as short as possible,but meaningful. + +.. image:: traininig_images/propose_file_change.png + :target: traininig_images/propose_file_change.png + :alt: propose_file_change + +5)**Create new pull request** + +Change destination branch into infra:main and click New Pull Request. + +.. image:: traininig_images/gitea_new_pull_request.png + :target: traininig_images/gitea_new_pull_request.png + :alt: gitea_new_pull_request + +Change destination branch into infra:main and click New Pull Request + +.. image:: traininig_images/gitea_new_pull_request2.png + :target: traininig_images/gitea_new_pull_request2.png + :alt: gitea_new_pull_request2 + +Once again - New Pull Request + +.. image:: traininig_images/gitea_new_pull_request3.png + :target: traininig_images/gitea_new_pull_request3.png + :alt: gitea_new_pull_request3 + +6)**New pull request approve, gate** + +.. image:: traininig_images/gitea_new_pull_request_approve_gate.png + :target: traininig_images/gitea_new_pull_request_approve_gate.png + :alt: gitea_new_pull_request_approve_gate + +7)**Delete branch** diff --git a/doc/source/helpcenter/helpcenter_training/faq/how_to_update_component_page.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_component_page.rst new file mode 100644 index 0000000..14e4830 --- /dev/null +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_component_page.rst @@ -0,0 +1,94 @@ +============================ +How to update component page +============================ + +**Goal** + +Mark service as depricated + +.. image:: training_images/storage_component_overview2.png + :target: training_images/storage_component_overview2.png + :alt: storage_component_overview + + +1)**Create fork on github** + +You need to create fork only in case you don’t have existing already + +.. image:: training_images/create_github_fork_1.png + :target: training_images/create_github_fork_1.png + :alt: create_fork_1 + +Choose your name as owner + +.. image:: training_images/create_github_fork_2.png + :target: training_images/create_github_fork_2.png + :alt: create_fork_2 + +2)**In case you have existing fork** + +You need to sync your fork with main. Then go to branches. + +.. image:: training_images/github_sync_fork.png + :target: training_images/github_sync_fork.png + :alt: sync_fork + +3)**Create new branch** + +.. image:: training_images/github_new_branch.png + :target: training_images/github_new_branch.png + :alt: new_branch + +Add new branch name: + +.. image:: training_images/github_new_branch2.png + :target: training_images/github_new_branch2.png + :alt: new_branch2 + +4)**Edit index.rst** + +.. image:: training_images/edit_index_rst.png + :target: training_images/edit_index_rst.png + :alt: edit_index.rst + +5)**Edit conf.py ** + +.. image:: training_images/edit_conf_py.png + :target: training_images/edit_conf_py.png + :alt: edit_conf_py + +6)**Commit changes** + +Once you finish with editing of pages click commit changes. + +.. image:: training_images/commit_changes.png + :target: training_images/commit_changes.png + :alt: commit_changes + +7)**Compare & pull request** + +.. image:: training_images/compare_pull_request.png + :target: training_images/compare_pull_request.png + :alt: compare_changes + +8)**Comparing changes** + +Check correct source and target pull request and branch. Then create pull request. + +.. image:: training_images/compare_changes.png + :target: training_images/compare_changes.png + :alt: compare_changes2 + +9)**Wait for checks, approve and gate** + +.. image:: training_images/check_approve_gate.png + :target: training_images/check_approve_gate.png + :alt: check_approve_gate + +10)**Delete branch** + +After successful merge delete branch. + +.. image:: training_images/delete_branch.png + :target: training_images/delete_branch.png + :alt: delete_branch diff --git a/doc/source/helpcenter/helpcenter_training/faq/how_to_update_landing_page.rst b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_landing_page.rst new file mode 100644 index 0000000..9f821c9 --- /dev/null +++ b/doc/source/helpcenter/helpcenter_training/faq/how_to_update_landing_page.rst @@ -0,0 +1,89 @@ +============================= +How to update landing page +============================= + +**Goal** + +Mark service as depricated + +.. image:: training_images/storage_component_overview.png + :target: training_images/storage_component_overview.png + :alt: storage_component_overview + +1)**Create fork on gitea** + +You need to create fork only in case you don’t have existing already + +.. image:: traininig_images/infra_otc_metadata.png + :target: traininig_images/infra_otc_metadata.png + :alt: infra_otc_metadata + +https://gitea.eco.tsi-dev.otc-service.com/marmulle/otc-metadata/src/branch/main/otc_metadata/data/documents + +2)**Sync fork** + +Sync work with main currently do not support sync in console and you need to do it manually. + +- you need to configure .ssh/config.ssh/config + +.. code-block:: text + + Host gitea.eco.tsi-dev.otc-service.com + User git + Port 2222 + HostName gitea.eco.tsi-dev.otc-service.com + IdentityFile ~/.ssh/id_rsa + +You should be able to ssh gitea and get You've successfully authenticated message. + +.. code-block:: text + + ssh gitea.eco.tsi-dev.otc-service.com + +Clone your branch, not main: + +.. code-block:: text + + git clone ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/marmulle/otc-metadata.git + +Then follow instructions to recover fork: https://gitea.eco.tsi-dev.otc-service.com/docs/doc-exports/wiki/Recovering-Fork + +3)**Update necessary file** + +In this case I was updating obs-swiftapi.yaml located in https://gitea.eco.tsi-dev.otc-service.com/marmulle/otc-metadata/src/branch/main/otc_metadata/data/documents + +4)**Propose file changes** + +After update file propose file changes. Name of branch or pull request should be as short as possible,but meaningful. + +.. image:: traininig_images/propose_file_change.png + :target: traininig_images/propose_file_change.png + :alt: propose_file_change + +5)**Create new pull request** + +Change destination branch into infra:main and click New Pull Request. + +.. image:: traininig_images/gitea_new_pull_request.png + :target: traininig_images/gitea_new_pull_request.png + :alt: gitea_new_pull_request + +Change destination branch into infra:main and click New Pull Request + +.. image:: traininig_images/gitea_new_pull_request2.png + :target: traininig_images/gitea_new_pull_request2.png + :alt: gitea_new_pull_request2 + +Once again - New Pull Request + +.. image:: traininig_images/gitea_new_pull_request3.png + :target: traininig_images/gitea_new_pull_request3.png + :alt: gitea_new_pull_request3 + +6)**New pull request approve, gate** + +.. image:: traininig_images/gitea_new_pull_request_approve_gate.png + :target: traininig_images/gitea_new_pull_request_approve_gate.png + :alt: gitea_new_pull_request_approve_gate + +7)**Delete branch**