Reorganise release and deployment process documentation (#4528)

* Consolidate deployment documentation into a single shared space * Remove misguided attempt at a unified deployment flowchart * Fix redirects and page titles * Use simpler document title Co-authored-by: Madison Swain-Bowden <[email protected]> * Address Madison's editorial feedback * Cleanup, expand, edit, hopefully make things better but maybe not please let me know dear reviewer! --------- Co-authored-by: Madison Swain-Bowden <[email protected]>
WordPress · Aug 6, 2024 · 23467c8 · 23467c8
1 parent 5a6c120
commit 23467c8
Show file tree

Hide file tree

Showing 25 changed files with 530 additions and 434 deletions.
diff --git a/.codespell/ignore_lines.txt b/.codespell/ignore_lines.txt
@@ -1,7 +1,7 @@
 ;; Please include filenames and explanations for each ignored line.
 ;; See https://docs.openverse.org/meta/codespell.html for docs.
 
-;; .github/workflows/release-app.yml
+;; .github/workflows/draft_releases.yml
 ;; The release-drafter/release-drafter configuration variable name cannot be changed
           commitish: main
 

diff --git a/.github/workflows/draft_releases.yml b/.github/workflows/draft_releases.yml
@@ -44,7 +44,7 @@ jobs:
 
       # Each time this runs, it should replace the previous drafted release matching the tag prefix set in the release drafter config
       # This means there will always be a running drafted release for all apps
-      # Publishing the drafted release triggers the `release-app` workflow
+      # Publishing the drafted release triggers the "Tag docker image and trigger deployment" workflow
       - uses: release-drafter/release-drafter@v6
         id: release-drafter
         with:

diff --git a/.github/workflows/release-app.yml → ...g_docker_image_and_trigger_deployment.yml b/.github/workflows/release-app.yml → ...g_docker_image_and_trigger_deployment.yml
@@ -1,4 +1,4 @@
-name: Release app
+name: Tag Docker image and trigger deployment
 
 on:
   release:
@@ -11,7 +11,7 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  release-app:
+  tag-docker-image-and-trigger-deployment:
     name: Release app
     runs-on: ubuntu-latest
     # Prevent running this workflow on forks, it's unnecessary for external contributors

diff --git a/documentation/api/guides/deploy.md b/documentation/api/guides/deploy.md
diff --git a/documentation/api/guides/index.md b/documentation/api/guides/index.md
@@ -5,6 +5,5 @@
 
 quickstart
 test
-deploy
 documentation
 ```
diff --git a/documentation/catalog/guides/deployment.md b/documentation/catalog/guides/deployment.md
diff --git a/documentation/catalog/guides/index.md b/documentation/catalog/guides/index.md
@@ -4,8 +4,6 @@
 :titlesonly:
 
 quickstart
-deploy
 adding_a_new_provider
-deployment
 dag_testing
 ```
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -105,6 +105,11 @@ def add_ext_to_path():
     "meta/contribution/good_first_and_help_wanted_issues": "/general/contribution/good_first_and_help_wanted_issues.html",
     "frontend/reference/playwright_tests.html": "/frontend/reference/testing_guidelines.html#playwright-tests",
     "frontend/reference/storybook_tests.html": "/frontend/reference/testing_guidelines.html#storybook-tests",
+    "frontend/guides/deploy": "/meta/release_and_deployment/runbooks/frontend.html",
+    "api/guides/deploy": "/meta/release_and_deployment/runbooks/api.html",
+    "catalog/guides/deploy": "/meta/release_and_deployment/runbooks/catalog.html",
+    "catalog/guides/deployment": "/meta/release_and_deployment/index.html#catalog",
+    "ingestion_server/guides/deploy": "/meta/release_and_deployment/runbooks/ingestion_server.html",
 }
 
 myst_enable_extensions = ["linkify"]
diff --git a/documentation/frontend/guides/index.md b/documentation/frontend/guides/index.md
@@ -4,7 +4,6 @@
 :titlesonly:
 
 quickstart
-deploy
 test
 analytics
 icons