deleted duplicated pages
This commit is contained in:
parent
c8319629b2
commit
9761d27ce6
@ -1,94 +0,0 @@
|
|||||||
============================
|
|
||||||
How to update component page
|
|
||||||
============================
|
|
||||||
|
|
||||||
**Goal**
|
|
||||||
|
|
||||||
Mark service as depricated
|
|
||||||
|
|
||||||
.. image:: faq_images/storage_component_overview2.png
|
|
||||||
:target: faq_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:: 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:: 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:: faq_images/github_sync_fork.png
|
|
||||||
:target: faq_images/github_sync_fork.png
|
|
||||||
:alt: sync_fork
|
|
||||||
|
|
||||||
3)**Create new branch**
|
|
||||||
|
|
||||||
.. image:: faq_images/github_new_branch.png
|
|
||||||
:target: faq_images/github_new_branch.png
|
|
||||||
:alt: new_branch
|
|
||||||
|
|
||||||
Add new branch name:
|
|
||||||
|
|
||||||
.. image:: faq_images/github_new_branch2.png
|
|
||||||
:target: faq_images/github_new_branch2.png
|
|
||||||
:alt: new_branch2
|
|
||||||
|
|
||||||
4)**Edit index.rst**
|
|
||||||
|
|
||||||
.. image:: faq_images/edit_index_rst.png
|
|
||||||
:target: faq_images/edit_index_rst.png
|
|
||||||
:alt: edit_index.rst
|
|
||||||
|
|
||||||
5)**Edit conf.py **
|
|
||||||
|
|
||||||
.. 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:: faq_images/commit_changes.png
|
|
||||||
:target: faq_images/commit_changes.png
|
|
||||||
:alt: commit_changes
|
|
||||||
|
|
||||||
7)**Compare & pull request**
|
|
||||||
|
|
||||||
.. 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:: faq_images/compare_changes.png
|
|
||||||
:target: faq_images/compare_changes.png
|
|
||||||
:alt: compare_changes2
|
|
||||||
|
|
||||||
9)**Wait for checks, approve and gate**
|
|
||||||
|
|
||||||
.. 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:: faq_images/delete_branch.png
|
|
||||||
:target: faq_images/delete_branch.png
|
|
||||||
:alt: delete_branch
|
|
||||||
@ -1,89 +0,0 @@
|
|||||||
=============================
|
|
||||||
How to update landing page
|
|
||||||
=============================
|
|
||||||
|
|
||||||
**Goal**
|
|
||||||
|
|
||||||
Mark service as depricated
|
|
||||||
|
|
||||||
.. 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:: 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
|
|
||||||
|
|
||||||
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:: faq_images/propose_file_change.png
|
|
||||||
:target: faq_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:: 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:: 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:: 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:: 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**
|
|
||||||
Loading…
x
Reference in New Issue
Block a user