From e8eef73212bcb0837f281ea4e4137c32922e787f Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Fri, 3 Jul 2020 11:40:59 +0200 Subject: [PATCH 1/2] 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 From a4ca813cf5b40fb0f61e622471df0613d924c25a Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Fri, 3 Jul 2020 14:09:30 +0200 Subject: [PATCH 2/2] add symlink and make it work --- CONTRIBUTING.md | 6 +++--- docs/contributing/index.md | 1 + mkdocs.yml | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) create mode 120000 docs/contributing/index.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 837f0755..2ba7a66d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing -FluxCD toolkit is [Apache 2.0 licensed](LICENSE) and accepts contributions -via GitHub pull requests. This document outlines some of the conventions on -to make it easier to get your contribution accepted. +FluxCD toolkit is [Apache 2.0 licensed](https://github.com/fluxcd/toolkit/blob/master/LICENSE) +and accepts contributions via GitHub pull requests. This document outlines +some of the conventions on to make it easier to get your contribution accepted. We gratefully welcome improvements to issues and documentation as well as to code. diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 120000 index 00000000..f939e75f --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a02ea240..daed97b2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -90,3 +90,4 @@ nav: - Sync source git: cmd/tk_sync_source_git.md - Uninstall: cmd/tk_uninstall.md - Roadmap: roadmap/index.md + - Contributing: contributing/index.md