Skip to content

docs: add GitOps Deployments documentation#74

Open
9trocode wants to merge 6 commits into
mainfrom
feature/gitops-documentation
Open

docs: add GitOps Deployments documentation#74
9trocode wants to merge 6 commits into
mainfrom
feature/gitops-documentation

Conversation

@9trocode

@9trocode 9trocode commented Dec 21, 2025

Copy link
Copy Markdown
Contributor

Summary

Adds comprehensive documentation for PipeOps GitOps deployments feature.

Changes

  • New Documentation: docs/projects/gitops.md
    • GitOps overview and quick start guide
    • Complete pipeops.yaml manifest reference
    • Build, deploy, env, resources, autoscale, and network configuration
    • Sync policies (manual, auto, webhook)
    • Custom Kubernetes manifest support for BYOC and BYOS clusters
    • Cluster type restrictions (PKS vs BYOC/BYOS)
    • Best practices for GitOps workflows
    • Troubleshooting guide

Related PRs

Screenshots

N/A - Documentation only

Testing

  • Documentation renders correctly in Docusaurus
  • All links are valid
  • Code examples are accurate

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

- Add comprehensive GitOps documentation for pipeops.yaml manifest
- Document manifest reference (build, deploy, env, resources, autoscale, network)
- Explain sync policies (manual, auto, webhook)
- Document custom K8s manifest support for BYOC clusters
- Add best practices and troubleshooting guides
@aws-amplify-eu-west-2

Copy link
Copy Markdown

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-74.d1tpup3oe5vsmi.amplifyapp.com

- Add Sync Waves section with ordering rules and configuration
- Add Drift Detection section with types, configuration, and response options
- Add Preview Environments section with PR workflow, configuration, and cleanup policies
- Update Overview to highlight new features
- Add troubleshooting entries for new features
@vercel

vercel Bot commented Jan 26, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
pipeops-docs Ready Ready Preview, Comment Mar 24, 2026 6:01pm

Request Review

@9trocode

Copy link
Copy Markdown
Contributor Author

@copilot Custom Kubernetes Manifests (BYOC Only) this part is now BYOC and BYOS

Copilot AI commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

@copilot Custom Kubernetes Manifests (BYOC Only) this part is now BYOC and BYOS

Updated in commit 72d953f — the section heading is now "Custom Kubernetes Manifests (BYOC and BYOS)", the description includes BYOS (Bring Your Own Server), and the cluster type support table has a BYOS row added.

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