diff --git a/doc/source/internal/helpcenter_training/custom_content/component_page.rst b/doc/source/internal/helpcenter_training/custom_content/component_page.rst index c935525..1a302ae 100644 --- a/doc/source/internal/helpcenter_training/custom_content/component_page.rst +++ b/doc/source/internal/helpcenter_training/custom_content/component_page.rst @@ -1,94 +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 - -9)**Delete branch** - -After successful merge delete branch. - -.. image:: training_images/delete_branch.png - :target: training_images/delete_branch.png - :alt: delete_branch \ No newline at end of file +============================ +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/internal/helpcenter_training/custom_content/landing_page.rst b/doc/source/internal/helpcenter_training/custom_content/landing_page.rst index 5a645bb..1a6e588 100644 --- a/doc/source/internal/helpcenter_training/custom_content/landing_page.rst +++ b/doc/source/internal/helpcenter_training/custom_content/landing_page.rst @@ -1,92 +1,92 @@ -============================ -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:: training_images/infra_otc-metadata.png - :target: training_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:: training_images/propose_file_change.png - :target: training_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:: training_images/gitea_new_pull_request.png - :target: training_images/gitea_new_pull_request.png - :alt: gitea_new_pull_request - -Change destination branch into infra:main and click New Pull Request - -.. image:: training_images/gitea_new_pull_request2.png - :target: training_images/gitea_new_pull_request2.png - :alt: gitea_new_pull_request2 - -Once again - New Pull Request - -.. image:: training_images/gitea_new_pull_request3.png - :target: training_images/gitea_new_pull_request3.png - :alt: gitea_new_pull_request3 - -6)**New pull request – approve, gate** - -.. image:: training_images/gitea_new_pull_request_approve_gate.png - :target: training_images/gitea_new_pull_request_approve_gate.png - :alt: gitea_new_pull_request_approve_gate - -7)**Delete branch** \ No newline at end of file +============================ +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:: /training_images/infra_otc-metadata.png + :target: /training_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:: /training_images/propose_file_change.png + :target: /training_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:: /training_images/gitea_new_pull_request.png + :target: /training_images/gitea_new_pull_request.png + :alt: gitea_new_pull_request + +Change destination branch into infra:main and click New Pull Request + +.. image:: /training_images/gitea_new_pull_request2.png + :target: /training_images/gitea_new_pull_request2.png + :alt: gitea_new_pull_request2 + +Once again - New Pull Request + +.. image:: /training_images/gitea_new_pull_request3.png + :target: /training_images/gitea_new_pull_request3.png + :alt: gitea_new_pull_request3 + +6)**New pull request – approve, gate** + +.. image:: /training_images/gitea_new_pull_request_approve_gate.png + :target: /training_images/gitea_new_pull_request_approve_gate.png + :alt: gitea_new_pull_request_approve_gate + +7)**Delete branch**