From 8cdab9e10197324318b7224d09aed5f36e3412b2 Mon Sep 17 00:00:00 2001 From: Tim Ramlot <42113979+inteon@users.noreply.github.com> Date: Wed, 6 Sep 2023 09:52:23 +0200 Subject: [PATCH] re-organise the usage section & move missing topics to this section Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com> --- content/docs/manifest.json | 60 ++++++++++--------- content/docs/usage/certificate.md | 2 +- .../{concepts => usage}/certificaterequest.md | 2 +- .../{projects => usage}/csi-driver-spiffe.md | 0 .../docs/{projects => usage}/csi-driver.md | 0 content/docs/usage/gateway.md | 2 +- content/docs/usage/ingress.md | 2 +- content/docs/{projects => usage}/istio-csr.md | 9 ++- content/docs/usage/istio.md | 17 ------ content/docs/usage/kube-csr.md | 2 +- public/_redirects | 6 ++ 11 files changed, 51 insertions(+), 51 deletions(-) rename content/docs/{concepts => usage}/certificaterequest.md (99%) rename content/docs/{projects => usage}/csi-driver-spiffe.md (100%) rename content/docs/{projects => usage}/csi-driver.md (100%) rename content/docs/{projects => usage}/istio-csr.md (92%) delete mode 100644 content/docs/usage/istio.md diff --git a/content/docs/manifest.json b/content/docs/manifest.json index b87e4703f8a..28fff457fa6 100644 --- a/content/docs/manifest.json +++ b/content/docs/manifest.json @@ -298,36 +298,58 @@ "path": "/docs/usage/README.md" }, { - "title": "Certificate Resources", + "title": "cm Certificate", "path": "/docs/usage/certificate.md" }, { - "title": "Prometheus Metrics", - "path": "/docs/usage/prometheus-metrics.md" + "title": "cm CertificateRequest", + "path": "/docs/usage/certificaterequest.md" }, { - "title": "Securing Ingress Resources", + "title": "k8s Ingress", "path": "/docs/usage/ingress.md" }, { - "title": "Securing Gateway Resources", + "title": "k8s Gateway", "path": "/docs/usage/gateway.md" }, { - "title": "Securing Istio Service Mesh", - "path": "/docs/usage/istio.md" + "title": "k8s CertificateSigningRequests", + "path": "/docs/usage/kube-csr.md" }, { - "title": "CSI Driver", - "path": "/docs/usage/csi.md" + "title": "Service Mesh", + "routes": [ + { + "title": "istio-csr", + "path": "/docs/usage/istio-csr.md" + } + ] }, { - "title": "Kubernetes CertificateSigningRequests", - "path": "/docs/usage/kube-csr.md" + "title": "CSI Driver", + "routes": [ + { + "title": "Introduction", + "path": "/docs/usage/csi.md" + }, + { + "title": "csi-driver", + "path": "/docs/usage/csi-driver.md" + }, + { + "title": "csi-driver-spiffe", + "path": "/docs/usage/csi-driver-spiffe.md" + } + ] }, { "title": "Policy for cert-manager certificates", "path": "/docs/usage/approver-policy.md" + }, + { + "title": "Prometheus Metrics", + "path": "/docs/usage/prometheus-metrics.md" } ] }, @@ -338,18 +360,6 @@ "title": "Contents", "path": "/docs/projects/README.md" }, - { - "title": "istio-csr", - "path": "/docs/projects/istio-csr.md" - }, - { - "title": "csi-driver", - "path": "/docs/projects/csi-driver.md" - }, - { - "title": "csi-driver-spiffe", - "path": "/docs/projects/csi-driver-spiffe.md" - }, { "title": "approver-policy", "routes": [ @@ -695,10 +705,6 @@ "title": "Certificate", "path": "/docs/concepts/certificate.md" }, - { - "title": "CertificateRequest", - "path": "/docs/concepts/certificaterequest.md" - }, { "title": "ACME Orders and Challenges", "path": "/docs/concepts/acme-orders-challenges.md" diff --git a/content/docs/usage/certificate.md b/content/docs/usage/certificate.md index 17792853bfc..09e3c46a59e 100644 --- a/content/docs/usage/certificate.md +++ b/content/docs/usage/certificate.md @@ -1,5 +1,5 @@ --- -title: Certificate Resources +title: cert-manager.io Certificate description: 'cert-manager usage: Certificates' --- diff --git a/content/docs/concepts/certificaterequest.md b/content/docs/usage/certificaterequest.md similarity index 99% rename from content/docs/concepts/certificaterequest.md rename to content/docs/usage/certificaterequest.md index 5dbc1ca5465..6f1d0929480 100644 --- a/content/docs/concepts/certificaterequest.md +++ b/content/docs/usage/certificaterequest.md @@ -1,5 +1,5 @@ --- -title: CertificateRequest +title: cert-manager.io CertificateRequest description: 'cert-manager core concepts: CertificateRequests' --- diff --git a/content/docs/projects/csi-driver-spiffe.md b/content/docs/usage/csi-driver-spiffe.md similarity index 100% rename from content/docs/projects/csi-driver-spiffe.md rename to content/docs/usage/csi-driver-spiffe.md diff --git a/content/docs/projects/csi-driver.md b/content/docs/usage/csi-driver.md similarity index 100% rename from content/docs/projects/csi-driver.md rename to content/docs/usage/csi-driver.md diff --git a/content/docs/usage/gateway.md b/content/docs/usage/gateway.md index 45f8fe62b71..ae852ef6b72 100644 --- a/content/docs/usage/gateway.md +++ b/content/docs/usage/gateway.md @@ -1,5 +1,5 @@ --- -title: Securing gateway.networking.k8s.io Gateway Resources +title: Annotated gateway.networking.k8s.io Gateway description: 'cert-manager usage: Kubernetes Gateways' --- diff --git a/content/docs/usage/ingress.md b/content/docs/usage/ingress.md index 26ff55751ec..af82abbd0aa 100644 --- a/content/docs/usage/ingress.md +++ b/content/docs/usage/ingress.md @@ -1,5 +1,5 @@ --- -title: Securing Ingress Resources +title: Annotated networking.k8s.io Ingress description: 'cert-manager usage: Kubernetes Ingress' --- diff --git a/content/docs/projects/istio-csr.md b/content/docs/usage/istio-csr.md similarity index 92% rename from content/docs/projects/istio-csr.md rename to content/docs/usage/istio-csr.md index 57748517bcf..19ae2eb4bdd 100644 --- a/content/docs/projects/istio-csr.md +++ b/content/docs/usage/istio-csr.md @@ -1,8 +1,13 @@ --- -title: istio-csr -description: '' +title: Securing Istio Service Mesh +description: 'cert-manager usage: Istio and istio-csr' --- +cert-manager can be integrated with [Istio](https://istio.io) using the project +[istio-csr](https://github.com/cert-manager/istio-csr). istio-csr will deploy an +agent that is responsible for receiving certificate signing requests for all +members of the Istio mesh, and signing them through cert-manager. + istio-csr is an agent that allows for [Istio](https://istio.io) workload and control plane components to be secured using [cert-manager](https://cert-manager.io). diff --git a/content/docs/usage/istio.md b/content/docs/usage/istio.md deleted file mode 100644 index 86149ae22b4..00000000000 --- a/content/docs/usage/istio.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Securing Istio Service Mesh -description: 'cert-manager usage: Istio and istio-csr' ---- - -cert-manager can be integrated with [Istio](https://istio.io) using the project -[istio-csr](https://github.com/cert-manager/istio-csr). istio-csr will deploy an -agent that is responsible for receiving certificate signing requests for all -members of the Istio mesh, and signing them through cert-manager. - -[istio-csr](https://github.com/cert-manager/istio-csr) will sign all control -plane and workload certificates via your chosen cert-manager Issuer. - ---- - -Please follow the instructions for installing and using istio-csr on the -[project page](../projects/istio-csr.md). diff --git a/content/docs/usage/kube-csr.md b/content/docs/usage/kube-csr.md index f6abb93f74a..a4ff6a1a532 100644 --- a/content/docs/usage/kube-csr.md +++ b/content/docs/usage/kube-csr.md @@ -1,5 +1,5 @@ --- -title: Kubernetes CertificateSigningRequests +title: certificates.k8s.io CertificateSigningRequest description: 'cert-manager usage: Kubernetes CertificateSigningRequest resources' --- diff --git a/public/_redirects b/public/_redirects index 37129ed5b97..c9e643e24b0 100644 --- a/public/_redirects +++ b/public/_redirects @@ -2,6 +2,12 @@ https://netlify.cert-manager.io/* https://cert-manager.io/:splat 301! https://cert-manager.netlify.com/* https://cert-manager.io/:splat 301! +# Integrating the project pages into the main website +/docs/usage/istio/ /docs/usage/istio-csr/ 301! +/docs/projects/istio-csr/ /docs/usage/istio-csr/ 301! +/docs/projects/csi-driver/ /docs/usage/csi-driver/ 301! +/docs/projects/csi-driver-spiffe/ /docs/usage/csi-driver-spiffe/ 301! + # Redirect all next-docs on the main site to the release-next preview https://cert-manager.io/next-docs/* https://release-next--cert-manager-website.netlify.app/docs/:splat 301!