From 8625ac100a7b062477f87e75f79617cd6db838a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Fri, 27 Oct 2023 11:40:40 +0200 Subject: [PATCH] Improve phrasing in README instruction (#109) --- README.md | 2 +- docs/index.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 76cb1ca0..654ba3a7 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ The expected format of the service account key is a **json** with the following } ``` -3. Configure the service account key and private key for authentication in the SDK: +3. Configure the service account key and private key for authentication in the SDK by following one of the alternatives below: - setting the fiels in the provider block: `service_account_key` or `service_account_key_path`, `private_key` or `private_key_path` - setting environment variables: `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` - setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above) diff --git a/docs/index.md b/docs/index.md index de469b99..46e2e4ca 100644 --- a/docs/index.md +++ b/docs/index.md @@ -96,7 +96,7 @@ The expected format of the service account key is a **json** with the following } ``` -3. Configure the service account key and private key for authentication in the SDK: +3. Configure the service account key and private key for authentication in the SDK by following one of the alternatives below: - setting the fiels in the provider block: `service_account_key` or `service_account_key_path`, `private_key` or `private_key_path` - setting environment variables: `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` - setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH` and `STACKIT_PRIVATE_KEY_PATH` in the credentials file (see above) @@ -110,6 +110,7 @@ Using this flow is less secure since the token is long-lived. You can provide th 3. Setting it in the credentials file (see above) + ## Schema ### Optional