stackit-dev-tools/terraform-provider-stackitprivatepreview
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation (#354)

Browse source 
* Change title and description

* change the headers to have only one H1 header

* add links to documentation

* fix typos

* add useful links

* change title and description // add some links // fix typos

* Update README.md

Co-authored-by: João Palet <joao.palet@outlook.com>

* Update README.md

Co-authored-by: João Palet <joao.palet@outlook.com>

* fix link

* add correct link to issue reporting

---------

Co-authored-by: João Palet <joao.palet@outlook.com>
This commit is contained in:
GokceGK 2024-05-07 13:47:06 +02:00 • committed by GitHub
parent ed3a460a91
commit 1c36e5a300
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 44 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

8
templates/index.md.tmpl
View file

@ -1,6 +1,6 @@
# {{ .ProviderShortName | upper }} Provider
# {{ .ProviderShortName | upper }} Terraform Provider
The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
The STACKIT Terraform provider is the official Terraform provider to integrate all the resources developed by [STACKIT](https://www.stackit.de/en/).
## Example Usage
@ -8,14 +8,14 @@ The STACKIT provider is the official Terraform provider to integrate all the res
## Authentication
To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the STACKIT Portal an assign it the necessary permissions, e.g. `project.owner`. There are multiple ways to authenticate:
To authenticate, you will need a [service account](https://docs.stackit.cloud/stackit/en/service-accounts-134415819.html). Create it in the [STACKIT Portal](https://portal.stackit.cloud/) and assign it the necessary permissions, e.g. `project.owner`. There are multiple ways to authenticate:
- Key flow (recommended)
- Token flow
When setting up authentication, the provider will always try to use the key flow first and search for credentials in several locations, following a specific order:
1. Explicit configuration, e.g. by seting the field `stackit_service_account_key_path` in the provider block (see example below)
1. Explicit configuration, e.g. by setting the field `stackit_service_account_key_path` in the provider block (see example below)
2. Environment variable, e.g. by setting `STACKIT_SERVICE_ACCOUNT_KEY_PATH`
3. Credentials file