Intro to Flux community, refer to governance/coc

- make markdownlint happy - introduce Flux community briefly - link to CoC and Governance docs fixes: #19 Signed-off-by: Daniel Holbach <[email protected]>
fluxcd · Oct 27, 2020 · ec32e94 · ec32e94
1 parent d775762
commit ec32e94
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,3 @@
-## Code of Conduct
+# Code of Conduct
 
 The Flux community follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
 # Flux community
 
-Flux community content
+The [Flux project](https://github.com/fluxcd) aspires to be a vendor-neutral home for GitOps in a Cloud Native world.
+
+Started 2016 to automate deployments at Weaveworks, the project has grown dramatically since then. Especially since the planning of Flux v2 and GitOps Toolkit SDK it became clearer that the scope became more ambitious and that the Flux project has become the home for the Flux family of projects, all solving specific GitOps needs.
+
+## Rules
+
+The Flux community is governed by the [governance document](GOVERNANCE.md). We as a community follow the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## Meetings
 
@@ -9,9 +15,9 @@ We run regular meetings and discuss things there. We are very happy if new users
 - **Meeting times**
   - "early" meeting: Uneven weeks: Wed, 10:00 UTC
   - "late" meeting: Even weeks: Thu, 15:00 UTC
-- **Agenda and minutes**: https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/edit
-- **Flux calendar:** https://lists.cncf.io/g/cncf-flux-dev/calendar
-- **Video recordings:** https://www.youtube.com/playlist?list=PLbx4FZ4kOKntmgJqaT-iJ8tn4xat150yL
+- **Agenda and minutes**: <https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/edit>
+- **Flux calendar:** <https://lists.cncf.io/g/cncf-flux-dev/calendar>
+- **Video recordings:** <https://www.youtube.com/playlist?list=PLbx4FZ4kOKntmgJqaT-iJ8tn4xat150yL>
 
 We are looking forward to seeing you there.