chore(docs): Move OpenAPI docs to docs/openapi

Author: RemiBardon

.dockerignore

@@ -3,3 +3,5 @@
 !crates/**/*.rs
 !crates/*/Cargo.*
 !crates/*/static/
+!docs/
+docs/tutorials/

.github/workflows/release.yaml

@@ -20,6 +20,7 @@ on:
       # We changed how the workflow is ran:
       - ".github/workflows/release.yaml"
       # We changed some packaged documentation:
+      - "docs/openapi/**"
       - "crates/*/static/**"
 
 jobs:

.github/workflows/test.yaml

@@ -16,6 +16,7 @@ on:
       # We changed how the workflow is ran:
       - ".github/workflows/test.yaml"
       # We changed some packaged documentation:
+      - "docs/openapi/**"
       - "crates/*/static/**"
       # We changed how tests are ran:
       - "crates/*/tests/**"
@@ -36,6 +37,7 @@ on:
       # We changed how the workflow is ran:
       - ".github/workflows/test.yaml"
       # We changed some packaged documentation:
+      - "docs/openapi/**"
       - "crates/*/static/**"
       # We changed how tests are ran:
       - "crates/*/tests/**"
@@ -72,7 +74,7 @@ jobs:
         run: npm install -g @redocly/cli@latest
 
       - name: Lint OpenAPI specification file
-        run: scripts/openapi-lint
+        run: docs/openapi/openapi-lint
 
   smoke-test:
     if: github.event.pull_request.draft == false

Dockerfile

@@ -24,7 +24,7 @@ RUN cargo install --path crates/rest-api --bin prose-pod-api --profile="${CARGO_
 
 FROM redocly/cli:1.34.0 as api-docs
 
-COPY crates/rest-api/static/api-docs .
+COPY docs/openapi .
 RUN redocly bundle openapi.yaml -o /usr/share/prose-pod-api/static/api-docs/openapi.json --config redocly.cfg.yaml
 
 COPY crates/rest-api/static/api-docs/redoc* /usr/share/prose-pod-api/static/api-docs

Taskfile.dist.yaml

@@ -135,11 +135,11 @@ tasks:
 
   openapi:lint:
     desc: Lint the OpenAPI specification file.
-    cmd: "{{.ROOT_DIR}}/scripts/openapi-lint {{.CLI_ARGS}}"
+    cmd: "{{.ROOT_DIR}}/docs/openapi/openapi-lint {{.CLI_ARGS}}"
 
   openapi:preview-docs:
     desc: Preview the OpenAPI specification file in a graphical interface.
-    cmd: "{{.ROOT_DIR}}/scripts/openapi-preview-docs {{.CLI_ARGS}}"
+    cmd: "{{.ROOT_DIR}}/dosc/openapi/openapi-preview-docs {{.CLI_ARGS}}"
 
   openapi:update-redoc:
     desc: Updates Redoc.