1
0
mirror of synced 2026-02-06 10:55:56 +00:00

Update docs website

- add notification-controller/api commands to index
- move diagrams to docs website
- update CRDs docs

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
This commit is contained in:
Stefan Prodan
2020-10-14 00:31:18 +03:00
parent 13f7d44a06
commit 90591e852d
15 changed files with 30 additions and 14 deletions

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 289 KiB

View File

@@ -245,7 +245,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
namespace: default
```
![helm-controller alerts](../diagrams/helm-controller-alerts.png)
![helm-controller alerts](../_files/helm-controller-alerts.png)
## Configure webhook receivers

View File

@@ -92,7 +92,7 @@ encountered during the reconciliation process.
This includes kustomize build and validation errors,
apply errors and health check failures.
![error alert](../diagrams/slack-error-alert.png)
![error alert](../_files/slack-error-alert.png)
When the verbosity is set to `info`, the controller will alert if:
@@ -101,7 +101,7 @@ When the verbosity is set to `info`, the controller will alert if:
* a dependency is delaying the execution
* an error occurs
![info alert](../diagrams/slack-info-alert.png)
![info alert](../_files/slack-info-alert.png)
## Git commit status
@@ -111,8 +111,8 @@ commit status works, refer to the [GitHub](https://docs.github.com/en/github/col
or [GitLab](https://docs.gitlab.com/ee/api/commits.html) documentation.
The first image is an example of how it may look like in GitHub while the one below is an example for GitLab.
![github commit status](../diagrams/github-commit-status.png)
![gitlab commit status](../diagrams/gitlab-commit-status.png)
![github commit status](../_files/github-commit-status.png)
![gitlab commit status](../_files/gitlab-commit-status.png)
Currently the provider will only work with Alerts for Kustomization resources as the events have to be linked with a
specific git commit. Any other event that does not contain a commit reference will be ignored by the provider.

View File

@@ -15,7 +15,7 @@ events and are responsible for the reconciliation of their designated API object
the toolkit is in an active experimentation phase.
If you wish to take part in this quest please reach out to us on Slack or GitHub.
![overview](diagrams/gotk-feature.png)
![overview](diagrams/gitops-toolkit.png)
Target features: