From fb7046292bfec07b19726b48d69b462b7ad3b927 Mon Sep 17 00:00:00 2001 From: Zubair Haque Date: Sun, 21 Jul 2024 01:31:41 -0400 Subject: [PATCH] chore: documentation updates: grammar & rm whitespace (#1639) --- docs/advanced-features.md | 4 ++-- docs/remote-secrets.md | 3 +-- docs/shared-configuration-across-teams.md | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/advanced-features.md b/docs/advanced-features.md index 682a0c8c..dba1123f 100644 --- a/docs/advanced-features.md +++ b/docs/advanced-features.md @@ -17,13 +17,13 @@ Helmfile integrates [vals]() to import configuration parameters from following b See [Vals "Supported Backends"](https://github.com/helmfile/vals#supported-backends) for the full list of available backends. This feature was implemented in https://github.com/roboll/helmfile/pull/906. -If you're curious how it's designed and how it works, please consult the pull request. +If you're curious about how it's designed and how it works, please review the pull request. ### Deploy Kustomizations with Helmfile You can deploy [kustomize](https://github.com/kubernetes-sigs/kustomize) "kustomization"s with Helmfile. -Most of Kustomize operations that is usually done with `kustomize edit` can be done declaratively via Helm values.yaml files. +Most Kustomize operations are usually done with `kustomize edit` and can be done declaratively via Helm `values.yaml` files. Under the hood, Helmfile transforms the kustomization into a local chart in a temporary directory so that it can be `helm upgrade --install`ed. diff --git a/docs/remote-secrets.md b/docs/remote-secrets.md index 86aac7fc..abef656a 100644 --- a/docs/remote-secrets.md +++ b/docs/remote-secrets.md @@ -54,5 +54,4 @@ service: login: svc-login # fetched from vault password: pass -``` - +``` \ No newline at end of file diff --git a/docs/shared-configuration-across-teams.md b/docs/shared-configuration-across-teams.md index da7035b6..247860cb 100644 --- a/docs/shared-configuration-across-teams.md +++ b/docs/shared-configuration-across-teams.md @@ -1,6 +1,6 @@ # Shared Configuration Across Teams -Assume you have a two or more teams, each works for a different internal or external service, like: +Assume you have two or more teams, each work for a different internal or external service, like: - Product 1 - Product 2 @@ -30,7 +30,7 @@ releases: # snip ``` -This works, but what if you wanted to a separate cluster per service to achieve smaller blast radius? +This works, but what if you wanted to a separate cluster per service to achieve a smaller blast radius? Let's start by creating a `helmfile.yaml` for each service.