From bde7e95226ca67aa9189bf60e28cead6fc170498 Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Thu, 15 Feb 2024 09:57:18 +0000 Subject: [PATCH] Initalized CPN docs Reviewed-by: tischrei Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- doc/source/cpn/backend/index.rst | 14 ++++++++++++++ doc/source/cpn/frontend/index.rst | 16 ++++++++++++++++ doc/source/cpn/index.rst | 9 +++++++++ doc/source/index.rst | 1 + 4 files changed, 40 insertions(+) create mode 100644 doc/source/cpn/backend/index.rst create mode 100644 doc/source/cpn/frontend/index.rst create mode 100644 doc/source/cpn/index.rst diff --git a/doc/source/cpn/backend/index.rst b/doc/source/cpn/backend/index.rst new file mode 100644 index 0000000..047265a --- /dev/null +++ b/doc/source/cpn/backend/index.rst @@ -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. diff --git a/doc/source/cpn/frontend/index.rst b/doc/source/cpn/frontend/index.rst new file mode 100644 index 0000000..ecfd7b6 --- /dev/null +++ b/doc/source/cpn/frontend/index.rst @@ -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. diff --git a/doc/source/cpn/index.rst b/doc/source/cpn/index.rst new file mode 100644 index 0000000..05671b7 --- /dev/null +++ b/doc/source/cpn/index.rst @@ -0,0 +1,9 @@ +======================== +Circle Partner Navigator +======================== + +.. toctree:: + :maxdepth: 1 + + backend/index + frontend/index diff --git a/doc/source/index.rst b/doc/source/index.rst index 656cecd..bf624d8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,3 +6,4 @@ Internal Documentation :maxdepth: 2 training/index + cpn/index