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 index 14e4830..5556ce2 100644 --- 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 @@ -6,8 +6,8 @@ How to update component page Mark service as depricated -.. image:: training_images/storage_component_overview2.png - :target: training_images/storage_component_overview2.png +.. image:: faq_images/storage_component_overview2.png + :target: faq_images/storage_component_overview2.png :alt: storage_component_overview @@ -15,80 +15,80 @@ Mark service as depricated 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 +.. image:: faq_images/create_github_fork_1.png + :target: faq_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 +.. image:: faq_images/create_github_fork_2.png + :target: faq_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 +.. image:: faq_images/github_sync_fork.png + :target: faq_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 +.. image:: faq_images/github_new_branch.png + :target: faq_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 +.. image:: faq_images/github_new_branch2.png + :target: faq_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 +.. image:: faq_images/edit_index_rst.png + :target: faq_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 +.. image:: faq_images/edit_conf_py.png + :target: faq_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 +.. image:: faq_images/commit_changes.png + :target: faq_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 +.. image:: faq_images/compare_pull_request.png + :target: faq_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 +.. image:: faq_images/compare_changes.png + :target: faq_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 +.. image:: faq_images/check_approve_gate.png + :target: faq_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 +.. image:: faq_images/delete_branch.png + :target: faq_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 index 9f821c9..de1917b 100644 --- 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 @@ -6,16 +6,16 @@ How to update landing page Mark service as depricated -.. image:: training_images/storage_component_overview.png - :target: training_images/storage_component_overview.png +.. image:: faq_images/storage_component_overview.png + :target: faq_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 +.. image:: faq_images/infra_otc_metadata.png + :target: faq_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 @@ -56,34 +56,34 @@ In this case I was updating obs-swiftapi.yaml located in https://gitea.eco.tsi-d 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 +.. image:: faq_images/propose_file_change.png + :target: faq_images/propose_file_change.png + :alt: faq_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 +.. image:: faq_images/gitea_new_pull_request.png + :target: faq_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 +.. image:: faq_images/gitea_new_pull_request2.png + :target: faq_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 +.. image:: faq_images/gitea_new_pull_request3.png + :target: faq_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 +.. image:: faq_images/gitea_new_pull_request_approve_gate.png + :target: faq_images/gitea_new_pull_request_approve_gate.png :alt: gitea_new_pull_request_approve_gate 7)**Delete branch** diff --git a/doc/source/training/helpcenter_training/faq/faq_images/commit_changes.png b/doc/source/training/helpcenter_training/faq/faq_images/commit_changes.png deleted file mode 100644 index a9546a0..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/commit_changes.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/compare_changes.png b/doc/source/training/helpcenter_training/faq/faq_images/compare_changes.png deleted file mode 100644 index 5862467..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/compare_changes.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/compare_pull_request.png b/doc/source/training/helpcenter_training/faq/faq_images/compare_pull_request.png deleted file mode 100644 index 28ab358..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/compare_pull_request.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_1.png b/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_1.png deleted file mode 100644 index 454106d..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_1.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_2.png b/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_2.png deleted file mode 100644 index 148c1f6..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/create_github_fork_2.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/delete_branch.png b/doc/source/training/helpcenter_training/faq/faq_images/delete_branch.png deleted file mode 100644 index e9f7877..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/delete_branch.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/edit_conf_py.png b/doc/source/training/helpcenter_training/faq/faq_images/edit_conf_py.png deleted file mode 100644 index 700817d..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/edit_conf_py.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/edit_index_rst.png b/doc/source/training/helpcenter_training/faq/faq_images/edit_index_rst.png deleted file mode 100644 index e0fd683..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/edit_index_rst.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request.png b/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request.png deleted file mode 100644 index ae8f44e..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png b/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png deleted file mode 100644 index ae8f44e..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request2.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png b/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png deleted file mode 100644 index 4191a3a..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request3.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png b/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png deleted file mode 100644 index e0b2537..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/gitea_new_pull_request_approve_gate.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch.png b/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch.png deleted file mode 100644 index 73ea6df..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch2.png b/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch2.png deleted file mode 100644 index 5efddf3..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/github_new_branch2.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/github_sync_fork.png b/doc/source/training/helpcenter_training/faq/faq_images/github_sync_fork.png deleted file mode 100644 index 6cce6a1..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/github_sync_fork.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/infra_otc_metadata.png b/doc/source/training/helpcenter_training/faq/faq_images/infra_otc_metadata.png deleted file mode 100644 index e382075..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/infra_otc_metadata.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request.png b/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request.png deleted file mode 100644 index ae8f44e..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request2.png b/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request2.png deleted file mode 100644 index 4191a3a..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request2.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png b/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png deleted file mode 100644 index e0b2537..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/new_pull_request_approve_gate.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/otc_metadata_update.png b/doc/source/training/helpcenter_training/faq/faq_images/otc_metadata_update.png deleted file mode 100644 index e382075..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/otc_metadata_update.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/propose_file_change.png b/doc/source/training/helpcenter_training/faq/faq_images/propose_file_change.png deleted file mode 100644 index 613d71f..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/propose_file_change.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview.png b/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview.png deleted file mode 100644 index 459ad9b..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview2.png b/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview2.png deleted file mode 100644 index 46a245c..0000000 Binary files a/doc/source/training/helpcenter_training/faq/faq_images/storage_component_overview2.png and /dev/null differ diff --git a/doc/source/training/helpcenter_training/faq/how_to_update_a_component_page.rst b/doc/source/training/helpcenter_training/faq/how_to_update_a_component_page.rst deleted file mode 100644 index 14e4830..0000000 --- a/doc/source/training/helpcenter_training/faq/how_to_update_a_component_page.rst +++ /dev/null @@ -1,94 +0,0 @@ -============================ -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/training/helpcenter_training/faq/how_to_update_a_landing_page.rst b/doc/source/training/helpcenter_training/faq/how_to_update_a_landing_page.rst deleted file mode 100644 index 9f821c9..0000000 --- a/doc/source/training/helpcenter_training/faq/how_to_update_a_landing_page.rst +++ /dev/null @@ -1,89 +0,0 @@ -============================= -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**