From d3c34d61f20b22f13b776ba0ef51b179f7bc290c Mon Sep 17 00:00:00 2001 From: Joseph Gardner Date: Sat, 10 Jun 2023 18:57:38 -0400 Subject: [PATCH] fix(docs): table and list formatting (#891) Signed-off-by: Joseph Gardner --- docs/index.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3da8cf5f..a24cccb9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1073,6 +1073,7 @@ That is, `myapp1` and `myapp2` are deleted first, then `servicemesh`, and finall ### Selectors and `needs` When using selectors/labels, `needs` are ignored by default. This behaviour can be overruled with a few parameters: + | Parameter | default | Description | |---|---|---| | `--skip-needs` | `true` | `needs` are ignored (default behavior). | @@ -1136,19 +1137,19 @@ In case you want more control over how multiple `helmfile.yaml` files are organi Suppose you have multiple microservices organized in a Git repository that looks like: * `myteam/` (sometimes it is equivalent to a k8s ns, that is `kube-system` for `clusterops` team) - * `apps/` - * `filebeat/` - * `helmfile.yaml` (no `charts/` exists, because it depends on the stable/filebeat chart hosted on the official helm charts repository) - * `README.md` (each app managed by my team has a dedicated README maintained by the owners of the app) - * `metricbeat/` - * `helmfile.yaml` - * `README.md` - * `elastalert-operator/` - * `helmfile.yaml` - * `README.md` - * `charts/` + * `apps/` + * `filebeat/` + * `helmfile.yaml` (no `charts/` exists because it depends on the stable/filebeat chart hosted on the official helm charts repository) + * `README.md` (each app managed by my team has a dedicated README maintained by the owners of the app) + * `metricbeat/` + * `helmfile.yaml` + * `README.md` * `elastalert-operator/` - * `` + * `helmfile.yaml` + * `README.md` + * `charts/` + * `elastalert-operator/` + * `` The benefits of this structure is that you can run `git diff` to locate in which directory=microservice a git commit has changes. It allows your CI system to run a workflow for the changed microservice only.