From 8ee050527520837b33c6849ae8300e33db97ccf1 Mon Sep 17 00:00:00 2001 From: Owen Date: Tue, 25 Aug 2026 17:04:09 -0400 Subject: [PATCH] Move the k8s docs under the site --- docs.json | 24 +++++++++---------- .../configure-ai-clients/claude-desktop.mdx | 12 ++++------ .../sites/kubernetes}/configuration.mdx | 14 ++++++----- .../newt => manage/sites/kubernetes}/helm.mdx | 6 ++--- .../sites/kubernetes}/kustomize.mdx | 12 ++++++---- .../sites/kubernetes}/troubleshooting.mdx | 10 ++++---- manage/ssh.mdx | 3 +-- self-host/advanced/observability.mdx | 4 ++-- self-host/manual/kubernetes/helm.mdx | 11 --------- self-host/manual/kubernetes/kustomize.mdx | 2 +- self-host/manual/kubernetes/overview.mdx | 6 ++--- 11 files changed, 47 insertions(+), 57 deletions(-) rename {self-host/manual/kubernetes/newt => manage/sites/kubernetes}/configuration.mdx (96%) rename {self-host/manual/kubernetes/newt => manage/sites/kubernetes}/helm.mdx (97%) rename {self-host/manual/kubernetes/newt => manage/sites/kubernetes}/kustomize.mdx (96%) rename {self-host/manual/kubernetes/newt => manage/sites/kubernetes}/troubleshooting.mdx (97%) diff --git a/docs.json b/docs.json index 58c7c44..b4a453d 100644 --- a/docs.json +++ b/docs.json @@ -44,7 +44,16 @@ "manage/sites/update-site", "manage/sites/auto-update", "manage/sites/credentials", - "manage/sites/site-provisioning" + "manage/sites/site-provisioning", + { + "group": "Kubernetes", + "pages": [ + "manage/sites/kubernetes/helm", + "manage/sites/kubernetes/kustomize", + "manage/sites/kubernetes/configuration", + "manage/sites/kubernetes/troubleshooting" + ] + } ] }, { @@ -271,15 +280,6 @@ "self-host/manual/kubernetes/gitops/flux" ] }, - { - "group": "Site (newt)", - "pages": [ - "self-host/manual/kubernetes/newt/helm", - "self-host/manual/kubernetes/newt/kustomize", - "self-host/manual/kubernetes/newt/configuration", - "self-host/manual/kubernetes/newt/troubleshooting" - ] - }, { "group": "Pangolin", "pages": [ @@ -529,7 +529,7 @@ }, { "source": "/manage/sites/install-kubernetes", - "destination": "/self-host/manual/kubernetes/newt/helm", + "destination": "/manage/sites/kubernetes/helm", "permanent": true }, { @@ -571,4 +571,4 @@ "og:image": "/images/home-social-graph.png" } } -} +} \ No newline at end of file diff --git a/manage/ai/configure-ai-clients/claude-desktop.mdx b/manage/ai/configure-ai-clients/claude-desktop.mdx index e66cfaf..68186cb 100644 --- a/manage/ai/configure-ai-clients/claude-desktop.mdx +++ b/manage/ai/configure-ai-clients/claude-desktop.mdx @@ -9,8 +9,7 @@ Claude Desktop can route its requests through a third-party inference gateway in Claude Desktop third-party inference settings @@ -26,16 +25,14 @@ You'll need the resource's URL (its ``) and its API key (``). Bot 1. Open Claude Desktop, go to the menu in the top left and select **Help > Troubleshooting**, and turn on **Developer Mode**. Claude Desktop third-party inference settings 2. From the menu bar, open **Developer**, then **Configure Third-Party Inference…**. Claude Desktop third-party inference settings @@ -46,8 +43,7 @@ You'll need the resource's URL (its ``) and its API key (``). Bot - **Gateway API Key:** `` Claude Desktop third-party inference settings diff --git a/self-host/manual/kubernetes/newt/configuration.mdx b/manage/sites/kubernetes/configuration.mdx similarity index 96% rename from self-host/manual/kubernetes/newt/configuration.mdx rename to manage/sites/kubernetes/configuration.mdx index bae9dee..12b1bb3 100644 --- a/self-host/manual/kubernetes/newt/configuration.mdx +++ b/manage/sites/kubernetes/configuration.mdx @@ -1,7 +1,9 @@ --- title: "Configuration" description: "Configuration reference for Newt Kubernetes deployments." ----This page covers the main Newt Kubernetes configuration options for Helm and Kustomize workflows. +--- + +This page covers the main Newt Kubernetes configuration options for Helm and Kustomize workflows. For exhaustive option coverage, refer to the chart resources: @@ -692,7 +694,7 @@ helm upgrade --install newt fossorial/newt \ --set 'newtInstances[0].auth.existingSecretName=newt-auth' ``` -See [Site (newt) Helm](/self-host/manual/kubernetes/newt/helm) for the installation flow. +See [Site (newt) Helm](/manage/sites/kubernetes/helm) for the installation flow. ### Kustomize @@ -711,7 +713,7 @@ Then apply an overlay: kubectl apply -k overlays/site-a ``` -See [Newt Kustomize](/self-host/manual/kubernetes/newt/kustomize) for the Kustomize workflow. +See [Newt Kustomize](/manage/sites/kubernetes/kustomize) for the Kustomize workflow. ### GitOps @@ -748,13 +750,13 @@ See [GitOps](/self-host/manual/kubernetes/gitops/overview) for GitOps guidance. ## Next steps - + Install Newt with Helm. - + Install Newt with rendered manifests and Kustomize overlays. - + Debug Newt deployment and connection issues. diff --git a/self-host/manual/kubernetes/newt/helm.mdx b/manage/sites/kubernetes/helm.mdx similarity index 97% rename from self-host/manual/kubernetes/newt/helm.mdx rename to manage/sites/kubernetes/helm.mdx index 3d6949d..68026a1 100644 --- a/self-host/manual/kubernetes/newt/helm.mdx +++ b/manage/sites/kubernetes/helm.mdx @@ -395,13 +395,13 @@ OCI changes where Helm pulls the chart from. It does not change the values file ## Next steps - + Review all Newt chart options. - + Debug Newt deployment and connection issues. - + Install Newt with rendered manifests and Kustomize overlays. diff --git a/self-host/manual/kubernetes/newt/kustomize.mdx b/manage/sites/kubernetes/kustomize.mdx similarity index 96% rename from self-host/manual/kubernetes/newt/kustomize.mdx rename to manage/sites/kubernetes/kustomize.mdx index ae0ff5b..635b244 100644 --- a/self-host/manual/kubernetes/newt/kustomize.mdx +++ b/manage/sites/kubernetes/kustomize.mdx @@ -1,7 +1,9 @@ --- title: "Kustomize" description: "Deploy Newt on Kubernetes using Helm-rendered manifests and Kustomize overlays." ----Use Kustomize when you want to manage Newt with rendered manifests, environment-specific overlays, and explicit patches in Git. +--- + +Use Kustomize when you want to manage Newt with rendered manifests, environment-specific overlays, and explicit patches in Git. For Newt, the supported Kustomize workflow is: @@ -20,7 +22,7 @@ Use Kustomize if you: - use Argo CD or Flux with Kustomize sources - want to customize Helm-rendered output without forking the chart -For a simpler single-site setup, use [Newt Helm](/self-host/manual/kubernetes/newt/helm). +For a simpler single-site setup, use [Newt Helm](/manage/sites/kubernetes/helm). ## Supported approach @@ -595,13 +597,13 @@ Verify: ## Next steps - + Install Newt with Helm. - + Review Newt chart options. - + Debug Newt deployment and connection issues. diff --git a/self-host/manual/kubernetes/newt/troubleshooting.mdx b/manage/sites/kubernetes/troubleshooting.mdx similarity index 97% rename from self-host/manual/kubernetes/newt/troubleshooting.mdx rename to manage/sites/kubernetes/troubleshooting.mdx index 84e4848..2a62c4a 100644 --- a/self-host/manual/kubernetes/newt/troubleshooting.mdx +++ b/manage/sites/kubernetes/troubleshooting.mdx @@ -1,7 +1,9 @@ --- title: "Troubleshooting" description: "Diagnose and resolve common Newt Kubernetes deployment issues." ----Use this guide to troubleshoot Newt Kubernetes deployments installed with Helm, Kustomize, Argo CD, or Flux. +--- + +Use this guide to troubleshoot Newt Kubernetes deployments installed with Helm, Kustomize, Argo CD, or Flux. Start with the basic checks, then move to the section that matches the symptom. @@ -685,13 +687,13 @@ Before sharing diagnostics, remove: ## Next steps - + Review Newt chart options. - + Install Newt with Helm. - + Install Newt with rendered manifests and Kustomize overlays. diff --git a/manage/ssh.mdx b/manage/ssh.mdx index c4f5d81..4657ebd 100644 --- a/manage/ssh.mdx +++ b/manage/ssh.mdx @@ -362,8 +362,7 @@ If you need a password generated for your user on the remote system (for example Claude Desktop third-party inference settings diff --git a/self-host/advanced/observability.mdx b/self-host/advanced/observability.mdx index 3207a44..129621a 100644 --- a/self-host/advanced/observability.mdx +++ b/self-host/advanced/observability.mdx @@ -148,7 +148,7 @@ controller: ``` -Helm values for Newt are documented on the [Kubernetes Newt configuration page](/self-host/manual/kubernetes/newt/configuration). Controller and Gerbil ServiceMonitor values are documented on the [Kubernetes Pangolin configuration page](/self-host/manual/kubernetes/pangolin/configuration). +Helm values for Newt are documented on the [Kubernetes Newt configuration page](/manage/sites/kubernetes/configuration). Controller and Gerbil ServiceMonitor values are documented on the [Kubernetes Pangolin configuration page](/self-host/manual/kubernetes/pangolin/configuration). @@ -520,7 +520,7 @@ increase(pangolin_kube_controller_reconcile_errors_total[10m]) > 5 Traefik and metrics collection with Prometheus and Grafana. - + Verified Newt chart values for metrics, Services, and ServiceMonitor resources. diff --git a/self-host/manual/kubernetes/helm.mdx b/self-host/manual/kubernetes/helm.mdx index 13c26c8..1f1ae9e 100644 --- a/self-host/manual/kubernetes/helm.mdx +++ b/self-host/manual/kubernetes/helm.mdx @@ -55,7 +55,6 @@ It is recommended to create the namespace explicitly before installation. This a For detailed installation steps, see: * [Pangolin Helm Quick-Start](/self-host/manual/kubernetes/pangolin/helm) — Install Pangolin -* [Site (Newt) Helm Quick-Start](/self-host/manual/kubernetes/newt/helm) — Install Site (Newt) ## Install command patterns @@ -162,7 +161,6 @@ Common value sources: Full configuration options are documented here: * [Pangolin Configuration](/self-host/manual/kubernetes/pangolin/configuration) -* [Newt Configuration](/self-host/manual/kubernetes/newt/configuration) ## Artifact Hub and chart discovery @@ -337,10 +335,7 @@ Uninstalling a Helm release does not always remove persistent volumes, externall ## Troubleshooting -For component-specific troubleshooting, see: - * [Pangolin Troubleshooting](/self-host/manual/kubernetes/pangolin/troubleshooting) -* [Newt Troubleshooting](/self-host/manual/kubernetes/newt/troubleshooting) Useful Helm commands: @@ -367,15 +362,9 @@ kubectl logs -n pangolin Install Pangolin with the Helm chart. - - Install Site (Newt) with the Helm chart. - Configure Pangolin chart values for your cluster. - - Configure Newt chart values and credentials. - Deploy the charts with Argo CD. diff --git a/self-host/manual/kubernetes/kustomize.mdx b/self-host/manual/kubernetes/kustomize.mdx index 439ffc7..742a68c 100644 --- a/self-host/manual/kubernetes/kustomize.mdx +++ b/self-host/manual/kubernetes/kustomize.mdx @@ -359,7 +359,7 @@ kubectl get events -n pangolin --sort-by=.lastTimestamp Install Pangolin with rendered manifests and Kustomize overlays. - + Install Newt with rendered manifests and Kustomize overlays. diff --git a/self-host/manual/kubernetes/overview.mdx b/self-host/manual/kubernetes/overview.mdx index 2b52d98..7b8bd28 100644 --- a/self-host/manual/kubernetes/overview.mdx +++ b/self-host/manual/kubernetes/overview.mdx @@ -67,13 +67,13 @@ flowchart LR Diagnose and resolve Pangolin deployment issues. - + Install a Site connector with the Newt Helm chart. - + Configure Site connector credentials and runtime settings. - + Diagnose and resolve Site connector deployment issues.