From 9094f85487e49a1a0fd9f28ca2c2253ba5740bc4 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Thu, 11 Feb 2021 13:11:03 +0200 Subject: [PATCH] Add image automation to readme Sync community section readme/docs index Signed-off-by: Stefan Prodan --- README.md | 25 ++++++++++++++++--------- docs/index.md | 33 ++++++++++++++++++++------------- 2 files changed, 36 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 52d3955b..9b04086d 100644 --- a/README.md +++ b/README.md @@ -60,13 +60,12 @@ To get started with Flux, start [browsing the documentation](https://toolkit.fluxcd.io) or get started with one of the following guides: -- [Get started with Flux (deep dive)](https://toolkit.fluxcd.io/get-started/) -- [Installation](https://toolkit.fluxcd.io/guides/installation/) +- [Get started with Flux](https://toolkit.fluxcd.io/get-started/) - [Manage Helm Releases](https://toolkit.fluxcd.io/guides/helmreleases/) -- [Setup Notifications](https://toolkit.fluxcd.io/guides/notifications/) -- [Setup Webhook Receivers](https://toolkit.fluxcd.io/guides/webhook-receivers/) +- [Automate image updates to Git](https://toolkit.fluxcd.io/guides/image-update/) +- [Manage Kubernetes secrets with Mozilla SOPS](https://toolkit.fluxcd.io/guides/mozilla-sops/) -If you should need help, please refer to our **[Support page](https://fluxcd.io/support/)**. +If you need help, please refer to our **[Support page](https://fluxcd.io/support/)**. ## GitOps Toolkit @@ -96,17 +95,24 @@ guides](https://toolkit.fluxcd.io/dev-guides/source-watcher/). - [Provider CRD](https://toolkit.fluxcd.io/components/notification/provider/) - [Alert CRD](https://toolkit.fluxcd.io/components/notification/alert/) - [Receiver CRD](https://toolkit.fluxcd.io/components/notification/receiver/) - +- [Image Automation Controllers](https://toolkit.fluxcd.io/components/image/controller/) + - [ImageRepository CRD](https://toolkit.fluxcd.io/components/image/imagerepositories/) + - [ImagePolicy CRD](https://toolkit.fluxcd.io/components/image/imagepolicies/) + - [ImageUpdateAutomation CRD](https://toolkit.fluxcd.io/components/image/imageupdateautomations/) + ## Community -Need help or want to contribute? Please see the links below. The Flux project is always looking for new contributors and there are a multitude of ways to get involved. +Need help or want to contribute? Please see the links below. The Flux project is always looking for +new contributors and there are a multitude of ways to get involved. - Getting Started? - Look at our [Get Started guide](https://toolkit.fluxcd.io/get-started/) and give us feedback - Need help? - First: Ask questions on our [GH Discussions page](https://github.com/fluxcd/flux2/discussions) - Second: Talk to us in the #flux channel on [CNCF Slack](https://slack.cncf.io/) - - Please follow our [Support Guidelines](https://fluxcd.io/support/) (in short: be nice, be respectful of volunteers' time, understand that maintainers and contributors cannot respond to all DMs, and keep discussions in the public #flux channel as much as possible). + - Please follow our [Support Guidelines](https://fluxcd.io/support/) + (in short: be nice, be respectful of volunteers' time, understand that maintainers and + contributors cannot respond to all DMs, and keep discussions in the public #flux channel as much as possible). - Have feature proposals or want to contribute? - Propose features on our [GH Discussions page](https://github.com/fluxcd/flux2/discussions) - Join our upcoming dev meetings ([meeting access and agenda](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/view)) @@ -115,6 +121,7 @@ Need help or want to contribute? Please see the links below. The Flux project is ### Events -Check out our **[events calendar](https://fluxcd.io/community/#talks)**, both with upcoming talks you can attend or past events videos you can watch. +Check out our **[events calendar](https://fluxcd.io/community/#talks)**, +both with upcoming talks you can attend or past events videos you can watch. We look forward to seeing you with us! diff --git a/docs/index.md b/docs/index.md index 5ea62f11..18770995 100644 --- a/docs/index.md +++ b/docs/index.md @@ -68,27 +68,34 @@ Features: - Dependency management (infrastructure and workloads) - Alerting to external systems (webhook senders) - External events handling (webhook receivers) -- Configuration update automation (automated patching) -- Policy-driven validation (OPA, admission controllers) +- Automated container image updates to Git (image scanning and patching) +- Policy-driven validation (OPA, Kyverno, admission controllers) - Seamless integration with Git providers (GitHub, GitLab, Bitbucket) - Interoperability with workflow providers (GitHub Actions, Tekton, Argo) - Interoperability with Cluster API (CAPI) providers ## Community -The Flux project is always looking for new contributors and there are a multitude of ways to get involved. -Depending on what you want to do, some of the following bits might be your first steps: - -- **Read our [Community page](https://fluxcd.io/community/) to get a first impression of how we organise ourselves as a community.** -- Join our upcoming dev meetings ([meeting access and agenda](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/view)) -- Ask questions and add suggestions in our [GitOps Toolkit Discussions](https://github.com/fluxcd/toolkit/discussions) -- Talk to us in the #flux channel on [CNCF Slack](https://slack.cncf.io/) -- Join the [planning discussions](https://github.com/fluxcd/flux2/discussions) -- And if you are completely new to Flux v2 and the GitOps Toolkit, take a look at our [Get Started guide](get-started/index.md) and give us feedback -- Check out [how to contribute](contributing/index.md) to the project +Need help or want to contribute? Please see the links below. The Flux project is always looking for +new contributors and there are a multitude of ways to get involved. + +- Getting Started? + - Look at our [Get Started guide](https://toolkit.fluxcd.io/get-started/) and give us feedback +- Need help? + - First: Ask questions on our [GH Discussions page](https://github.com/fluxcd/flux2/discussions) + - Second: Talk to us in the #flux channel on [CNCF Slack](https://slack.cncf.io/) + - Please follow our [Support Guidelines](https://fluxcd.io/support/) + (in short: be nice, be respectful of volunteers' time, understand that maintainers and + contributors cannot respond to all DMs, and keep discussions in the public #flux channel as much as possible). +- Have feature proposals or want to contribute? + - Propose features on our [GH Discussions page](https://github.com/fluxcd/flux2/discussions) + - Join our upcoming dev meetings ([meeting access and agenda](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/view)) + - [Join the flux-dev mailing list](https://lists.cncf.io/g/cncf-flux-dev). + - Check out [how to contribute](contributing/index.md) to the project ### Events -Check out our **[events calendar](https://fluxcd.io/community/#talks)**, both with upcoming talks you can attend or past events videos you can watch. +Check out our **[events calendar](https://fluxcd.io/community/#talks)**, +both with upcoming talks you can attend or past events videos you can watch. We look forward to seeing you with us!