From eb49ee8df0954ff525d096de1f95ad65ddcc8e51 Mon Sep 17 00:00:00 2001 From: Nicholas Morey Date: Fri, 25 Nov 2022 15:31:04 -0500 Subject: [PATCH] docs: improve build env variable list formatting (#11429) * docs: normalize build env list Signed-off-by: Nicholas Morey * docs: use table instead of list Signed-off-by: Nicholas Morey * docs: remove separator from description Signed-off-by: Nicholas Morey Signed-off-by: Nicholas Morey Signed-off-by: emirot --- docs/user-guide/build-environment.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/user-guide/build-environment.md b/docs/user-guide/build-environment.md index c5219aa9fe0d1..57b1a2bed14bb 100644 --- a/docs/user-guide/build-environment.md +++ b/docs/user-guide/build-environment.md @@ -2,14 +2,16 @@ [Custom tools](config-management-plugins.md), [Helm](helm.md), [Jsonnet](jsonnet.md), and [Kustomize](kustomize.md) support the following build env vars: -* `ARGOCD_APP_NAME` - name of application -* `ARGOCD_APP_NAMESPACE` - destination application namespace. -* `ARGOCD_APP_REVISION` - the resolved revision, e.g. `f913b6cbf58aa5ae5ca1f8a2b149477aebcbd9d8` -* `ARGOCD_APP_SOURCE_PATH` - the path of the app within the repo -* `ARGOCD_APP_SOURCE_REPO_URL` the repo's URL -* `ARGOCD_APP_SOURCE_TARGET_REVISION` - the target revision from the spec, e.g. `master`. -* `KUBE_VERSION` - the version of kubernetes -* `KUBE_API_VERSIONS` = the version of kubernetes API +| Variable | Description | +| ----------------------------------- | ----------------------------------------------------------------------- | +| `ARGOCD_APP_NAME` | The name of the application. | +| `ARGOCD_APP_NAMESPACE` | The destination namespace of the application. | +| `ARGOCD_APP_REVISION` | The resolved revision, e.g. `f913b6cbf58aa5ae5ca1f8a2b149477aebcbd9d8`. | +| `ARGOCD_APP_SOURCE_PATH` | The path of the app within the source repo. | +| `ARGOCD_APP_SOURCE_REPO_URL` | The source repo URL. | +| `ARGOCD_APP_SOURCE_TARGET_REVISION` | The target revision from the spec, e.g. `master`. | +| `KUBE_VERSION` | The version of Kubernetes. | +| `KUBE_API_VERSIONS` | The version of the Kubernetes API. | In case you don't want a variable to be interpolated, `$` can be escaped via `$$`.