From e8eef73212bcb0837f281ea4e4137c32922e787f Mon Sep 17 00:00:00 2001 From: Daniel Holbach <daniel@weave.works> Date: Fri, 3 Jul 2020 11:40:59 +0200 Subject: [PATCH] explain a bit more about Flux Toolkit --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7db124e..837f0755 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ toolkit. The project uses Slack: To join the conversation, simply join the [CNCF](https://slack.cncf.io/) Slack workspace and use the -[#flux](https://cloud-native.slack.com/messages/flux/) channel. +[#flux-dev](https://cloud-native.slack.com/messages/flux-dev/) channel. The developers use a mailing list to discuss development as well. Simply subscribe to [flux-dev on cncf.io](https://lists.cncf.io/g/cncf-flux-dev) @@ -66,3 +66,15 @@ For Source Controller we prefer the following rules for good commit messages: The [following article](https://chris.beams.io/posts/git-commit/#seven-rules) has some more helpful advice on documenting your work. + +## Understanding the Flux Toolkit + +If you are entirely new to the Flux Toolkit, you might want to take a look at the [introductory talk and demo](https://www.youtube.com/watch?v=qQBtSkgl7tI). + +The project is comprised of: + +- [/f/toolkit](https://github.com/fluxcd/toolkit): toolkit for assembling CD pipelines the GitOps way +- [/f/source-manager](https://github.com/fluxcd/source-controller): source manager +- [/f/kustomize-controller](https://github.com/fluxcd/kustomize-controller): Kubernetes operator for building GitOps pipelines with Kustomize +- [/f/helm-controller](https://github.com/fluxcd/helm-controller): Kubernetes operator for building GitOps pipelines with Helm +- [/f/notification-controller](https://github.com/fluxcd/notification-controller): notification dispatcher -- GitLab