Initalized CPN docs

This commit is contained in:
Gode, Sebastian 2024-02-15 09:21:46 +00:00
parent 83ae870719
commit cc887552cc
4 changed files with 40 additions and 0 deletions

View File

@ -0,0 +1,14 @@
=======
Backend
=======
Updating the Backend
--------------------
You can update the Backend by following those steps:
1. Merge the Pull-Request
2. Wait until the gate job has been passed
3. Look at the Zuul-logs from the gate job. Find the line with `Successfully tagged quay.io` and remember the `:change_xx_latest` value
4. Open a Pull-Request to adjust the kustomization config to the new tag from step 3. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/base/kustomization.yaml#L14
5. Merge this Pull-Request and wait 10 minutes.

View File

@ -0,0 +1,16 @@
========
Frontend
========
Updating the Frontend
---------------------
You can update the Frontend by following those steps:
1. Merge the Pull-Request
2. Tag the desired commit and push the tag to Github. It should be visible afterwards on this page: https://github.com/opentelekomcloud-infra/circle-partner-navigator-frontend/tags
3. Wait at least 10 minutes
4. Open a Pull-Request to adjust the kustomization config to the new tag. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/base/kustomization.yaml#L16
5. Merge this Pull-Request and wait 10 minutes.
Be aware that updating the Frontend will also pull the data from the Backend again and as a result will also update the partner data on the website.

9
doc/source/cpn/index.rst Normal file
View File

@ -0,0 +1,9 @@
========================
Circle Partner Navigator
========================
.. toctree::
:maxdepth: 1
backend/index
frontend/index

View File

@ -6,3 +6,4 @@ Internal Documentation
:maxdepth: 2 :maxdepth: 2
training/index training/index
cpn/index