Skip to content

Add Kubernetes deployment guides for Newt and Pangolin#113

Open
marcschaeferger wants to merge 3 commits into
mainfrom
update-helm-chart
Open

Add Kubernetes deployment guides for Newt and Pangolin#113
marcschaeferger wants to merge 3 commits into
mainfrom
update-helm-chart

Conversation

@marcschaeferger
Copy link
Copy Markdown
Member

Summary (generated by Copilot)

This pull request adds comprehensive Kubernetes installation and GitOps documentation for Pangolin and Newt, expanding the documentation structure and providing detailed guides for different deployment methods and workflows. The main themes are the addition of Kubernetes-focused documentation sections and in-depth explanations of GitOps practices using Argo CD and Flux.

Documentation structure and navigation:

  • Updated docs.json to add a new "Kubernetes" group under "Manual Installation", including pages for Helm, Kustomize, Helmfile, and subgroups for GitOps (Argo CD, Flux), Newt, and Pangolin workflows.

Kubernetes installation workflows:

  • Added choose-method.mdx to help users select the appropriate Kubernetes installation method (Helm, Kustomize, Argo CD, Flux, Helmfile), with a decision table, detailed method descriptions, clarifications on OCI and raw YAML, and next steps.

GitOps documentation:

  • Added gitops/overview.mdx with a thorough explanation of GitOps concepts, benefits, tool comparisons (Argo CD vs. Flux), repository structure recommendations, secret management strategies, step-by-step workflow examples, and common use cases for multi-environment deployments and drift detection.

Notice

About 45 - 50% (4217 lines) of the Documentation were generated/enhanced by AI

…m, Kustomize, Helmfile, and GitOps for Newt and Pangolin

Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
…upport wording

Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
…cumentation. Covered now under the Kubernetes section

Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
Copy link
Copy Markdown
Member

@oschwartz10612 oschwartz10612 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please:

  • remove Newt 1.11+ when it says the version as we typically dont call out versions next to features like this across the docs.
  • remove the production checklists on all pages

Comment thread self-host/manual/kubernetes/choose-method.mdx
Comment thread self-host/manual/kubernetes/overview.mdx
Comment thread self-host/manual/kubernetes/overview.mdx
Comment thread self-host/manual/kubernetes/prerequisites.mdx
Comment thread self-host/manual/kubernetes/prerequisites.mdx
Comment thread self-host/manual/kubernetes/pangolin/kustomize.mdx
Comment thread self-host/manual/kubernetes/pangolin/helm.mdx
Comment thread self-host/manual/kubernetes/pangolin/configuration.mdx
Comment thread self-host/manual/kubernetes/pangolin/configuration.mdx
Comment thread self-host/manual/kubernetes/newt/configuration.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants