From 3d54e1943d091dc11ec914191c60ab50de23b3d5 Mon Sep 17 00:00:00 2001 From: Timon Viola Date: Thu, 14 Nov 2024 08:53:30 +0100 Subject: [PATCH] docs: describe k8s hosted documentation --- CONTRIBUTING.md | 4 ++++ docs-deployment.yaml => k8s/docs-deployment.yaml | 0 docs.Dockerfile => k8s/docs.Dockerfile | 2 +- nginx.conf => k8s/nginx.conf | 0 4 files changed, 5 insertions(+), 1 deletion(-) rename docs-deployment.yaml => k8s/docs-deployment.yaml (100%) rename docs.Dockerfile => k8s/docs.Dockerfile (60%) rename nginx.conf => k8s/nginx.conf (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a8270c..fe4cad9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,10 @@ The latest version of the documentation is available on a github pages site, lin To preview the documentation locally, you need to start mkdocs server. See [Go to Cheat sheet](#cheat-sheet) +## Stable/User documentation + +The deployment manifests and Dockerfile for the k8s hosted docs site is under `k8s/` + # Releases The project uses semantic versioning. diff --git a/docs-deployment.yaml b/k8s/docs-deployment.yaml similarity index 100% rename from docs-deployment.yaml rename to k8s/docs-deployment.yaml diff --git a/docs.Dockerfile b/k8s/docs.Dockerfile similarity index 60% rename from docs.Dockerfile rename to k8s/docs.Dockerfile index d5f94df..1fed6f8 100644 --- a/docs.Dockerfile +++ b/k8s/docs.Dockerfile @@ -1,4 +1,4 @@ FROM nginx:1.27.2-alpine -COPY ./site /data/www/dagcellent +COPY ../site /data/www/dagcellent COPY nginx.conf /etc/nginx diff --git a/nginx.conf b/k8s/nginx.conf similarity index 100% rename from nginx.conf rename to k8s/nginx.conf