From 60859155e603acc0960a9215ffef805d65696cc5 Mon Sep 17 00:00:00 2001 From: jbleduigou Date: Sat, 7 Oct 2023 14:18:27 +0200 Subject: [PATCH] doc: path is a string and should use double quotes --- CONTRIBUTING.md | 2 +- docs/configuration/cloud-providers/aws.mdx | 8 ++++---- docs/getting-started/quickstart.mdx | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fd542fef..591bd8dca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -204,7 +204,7 @@ An example configuration entry for configuring a Google Cloud account in the **` [[gcp]] name="production" source="ENVIRONMENT_VARIABLES" -# path=./path/to/credentials/file specify if 'CREDENTIALS_FILE' is used as source +# path="./path/to/credentials/file" specify if 'CREDENTIALS_FILE' is used as source profile="production" ``` diff --git a/docs/configuration/cloud-providers/aws.mdx b/docs/configuration/cloud-providers/aws.mdx index 5813009a1..7db1d54c6 100644 --- a/docs/configuration/cloud-providers/aws.mdx +++ b/docs/configuration/cloud-providers/aws.mdx @@ -97,19 +97,19 @@ Add to config.toml file [[aws]] name="sandbox" source="CREDENTIALS_FILE" -path=./path/to/credentials/file +path="./path/to/credentials/file" profile="default" [[aws]] name="staging" source="CREDENTIALS_FILE" -path=./path/to/credentials/file +path="./path/to/credentials/file" profile="staging-account" [[gcp]] name="production" source="ENVIRONMENT_VARIABLES" -# path=./path/to/credentials/file specify if CREDENTIALS_FILE is used +# path="./path/to/credentials/file" specify if CREDENTIALS_FILE is used profile="production" [postgres] @@ -136,7 +136,7 @@ profile="production" [[aws]] name="sandbox" source="CREDENTIALS_FILE" -path=./path/to/credentials/file +path="./path/to/credentials/file" profile="default" ``` ### Credentials file diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx index 2104a2a34..913d177a9 100644 --- a/docs/getting-started/quickstart.mdx +++ b/docs/getting-started/quickstart.mdx @@ -56,19 +56,19 @@ The reason for this external data persistence is to improve the filtering, sorti [[aws]] name="sandbox" source="CREDENTIALS_FILE" -path=./path/to/credentials/file +path="./path/to/credentials/file" profile="default" [[aws]] name="staging" source="CREDENTIALS_FILE" -path=./path/to/credentials/file +path="./path/to/credentials/file" profile="staging-account" [[gcp]] name="production" source="ENVIRONMENT_VARIABLES" -# path=./path/to/credentials/file specify if CREDENTIALS_FILE is used +# path="./path/to/credentials/file" specify if CREDENTIALS_FILE is used profile="production" [postgres]