mirror of
https://github.com/hanzoai/cd.git
synced 2026-10-30 14:56:45 +00:00
zeekay
7461a16638
Rewrites remaining Argo/ArgoCD/argocd/argoproj prose in docs/ to Hanzo CD,
in our own voice only. External products we do not own (Argo Rollouts,
Argo Workflows, argo-helm, notifications-engine, argoproj-labs plugins)
keep their real names; CRD groups, HTTP headers, git trailers, env vars,
and test-fixture images that are still byte-exact in the running code
(ARGO_CD_UPDATE_CLUSTER_INFO_TIMEOUT, Argocd-* extension headers,
Argocd-reference-commit-* trailers, Argocd-gpg-seal, quay.io/argoprojlabs
cd-e2e-container) are left untouched.
Deletes docs/operator-manual/upgrading/1.0-1.1.md through 3.4-3.5.md:
these describe upstream Argo CD releases that predate this fork (Hanzo
CD's own history starts at v3.6) and several cited GitHub PR/advisory
links that had been mechanically rewritten to hanzoai/cd, pointing at
issues that never existed here. Deletes docs/developer-guide/dependencies.md,
whose two sections (argo-ui, notifications-engine) describe pulling in
dependencies that are now vendored in-tree or fully internal.
Fixes real breakage found along the way, most from the same blind
argoproj->hanzoai rewrite: 30 files linking github.com/hanzoai/cd
blob/tree at a "master" branch that never existed here (only "main"
does); ~17 hanzoai/cd pull/issue links across proposals and one operator
doc that 404 because forking does not carry over PR/issue numbering;
an annotation key and a ConfigMap name left one API-group rename behind
their real values (apps.hanzo.ai/*, cd-rbac-cm); a page rename
(Argo-CD-Integration.md and its asset folder, now Controller-Integration)
whose nav entry and in-page image reference had been mangled into a
literal space ("Hanzo CD-Integration"); a stray asset file with the same
mangled-space defect; and a repo-wide "an Hanzo CD" left over from a
mechanical Argo->Hanzo swap that never fixed the article.
mkdocs.yml: trims the Upgrading nav to the one real entry, drops
dependencies.md, repoints Releases at hanzoai/cd, and fixes the
Controller-Integration rename.
Verified with a strict mkdocs build (0 warnings) after the fixes above.
Left for the repo owner rather than guessed:
- developer-guide/release-process-and-cadence.md and
proposals/feature-bounties*.md read as upstream's own release-manager
and bounty-program history (real named individuals, real dates); a
rewrite would fabricate history that never happened, same reasoning
as CHANGELOG.md.
- assets/versions.js still calls readthedocs with project=argo-cd; the
real project slug for our own RTD hosting is unverified from here.
- signed-release-assets.md's cosign --certificate-identity-regexp still
names .github/workflows/image-reuse.yaml, which does not exist in this
repo (no .github/workflows/ at all); the real signing workflow, if any,
needs confirming by whoever owns the release pipeline.
- maintaining-internal-cd-forks.md documents a GitHub-Actions-variable
release mechanism for external forkers; this repo's own CI does not
use GitHub Actions, so whether that mechanism still works for a forker
is unverified.
4.5 KiB
4.5 KiB
Overview
Warning
As a Hanzo CD user, you probably don't want to be reading this section of the docs.
This part of the manual is aimed at helping people contribute to Hanzo CD, documentation, or to develop third-party applications that interact with Hanzo CD, e.g.
- A chat bot
- A Slack integration
Preface
Understand the Code Contribution Guide
Understand the Code Contribution Preface
Contributing to Hanzo CD documentation
This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to Contributing to Hanzo CD backend and frontend
Fork and clone Hanzo CD repository
Submit your PR
Contributing to Hanzo CD backend and frontend
This guide will help you set up your build & test environment, so that you can start developing and testing bug fixes and feature enhancements without having to make too much effort in setting up a local toolchain.
As is the case with the development process, this document is under constant change. If you notice any error, or if you think this document is out-of-date, or if you think it is missing something: Feel free to submit a PR or submit a bug to our GitHub issue tracker.
Set up your development environment
- Install required tools (Git, Go, Docker, etc)
- Install and start a local K8s cluster (Kind, Minikube or K3d)
- Fork and clone Hanzo CD repository
- Install additional required development tools
- Install latest Hanzo CD on your local cluster
Set up a development toolchain (local or virtualized)
-
Choose a development toolchain
Perform the development cycle
- Set kubectl context to cd namespace
- Pull in all build dependencies
- Generate API glue code and other assets
- Build your code and run unit tests
- Lint your code base
- Run e2e tests
- How to contribute to documentation: build and run documentation site on your machine for manual testing
Run and debug Hanzo CD locally
Submit your PR
- Before submitting a PR
- Understand the Continuous Integration process
- Choose a correct title for your PR
- Perform the PR template checklist
- Understand the CI automated builds & tests
- Understand & make sure your PR meets the CI code test coverage requirements
Need help? Start with the Contributors FAQ