Merge pull request #61 from fluxcd/docs-features

Add target features and diagram to docs

.github/workflows/docs.yaml

@@ -17,6 +17,7 @@ jobs:
           cp install/tk.sh docs/install.sh
           curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/api/source.md > docs/components/source/api.md
           curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/gitrepositories.md > docs/components/source/gitrepositories.md
+          curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/helmrepositories.md > docs/components/source/helmrepositories.md
           curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/api/kustomize.md > docs/components/kustomize/api.md
           curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/spec/v1alpha1/kustomization.md > docs/components/kustomize/kustomization.md
       - name: Deploy docs

README.md

@@ -7,11 +7,6 @@
 
 Experimental toolkit for assembling CD pipelines the GitOps way.
 
-![overview](docs/diagrams/tk-overview.png)
+![overview](docs/diagrams/tk-feature.png)
 
-Components:
-* [Toolkit CLI](docs/cmd/tk.md)
-* [Source Controller](https://github.com/fluxcd/source-controller)
-* [Kustomize Controller](https://github.com/fluxcd/kustomize-controller)
-
-To install the toolkit CLI, follow the [instructions](install/README.md).
+To get started with the toolkit please read the [docs](https://toolkit.fluxcd.io/).

docs/index.md

@@ -10,16 +10,36 @@ The GitOps Toolkit components interact with each other via Kubernetes
 events and are responsible for the reconciliation of their designated API objects. 
 
 !!! hint "Work in Progress"
-    We envision a feature where **Flux v2** and **Helm Operator v2** will be assembled from
+    We envision a future where **Flux v2** and **Helm Operator v2** will be assembled from
     the GitOps Toolkit components. The Flux CD team is looking for feedback and help as 
     the toolkit is in an active experimentation phase.
     If you wish to take part in this quest please reach out to us on Slack and GitHub.
 
+![overview](diagrams/tk-feature.png)
+
+Target features:
+
+- Source management
+- Kustomize and Helm support 
+- Event-based and on-a-schedule reconciliation
+- Role-based reconciliation (multi-tenancy)
+- Health assessment (clusters and workloads)
+- Dependency management (infra and workloads)
+- Alerting to external systems (webhook senders)
+- External events handling (webhook receivers)
+- Source write-back (automated patching)
+- Policy driven validation (OPA, admission controllers)
+- Seamless integration with Git providers (GitHub, GitLab, BitBucket)
+- Interoperability with workflow providers (GitHub Actions, Tekton, Argo)
+
 Components:
 
 - [Toolkit CLI](https://github.com/fluxcd/toolkit)
 - [Source Controller](components/source/controller.md)
+    - [GitRepository CRD](components/source/gitrepositories.md)
+    - [HelmRepository CRD](components/source/helmrepositories.md)
 - [Kustomize Controller](components/kustomize/controller.md)
+    - [Kustomization CRD](components/kustomize/kustomization.md)
+- Helm Controller (TBA)
 
 To get started with the toolkit please follow this [guide](get-started/index.md).
-

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
   - Toolkit Components:
     - Source Controller: components/source/controller.md
     - GitRepository CRD: components/source/gitrepositories.md
+    - HelmRepository CRD: components/source/helmrepositories.md
     - Source API Reference: components/source/api.md
     - Kustomize Controller: components/kustomize/controller.md
     - Kustomization CRD: components/kustomize/kustomization.md