Add template for provider main page (#17)
* Add template * Generate docs --------- Co-authored-by: Henrique Santos <henrique.santos@freiheit.com>
This commit is contained in:
parent
52d7b3c040
commit
78dcc66e5e
2 changed files with 18 additions and 14 deletions
13
templates/index.md.tmpl
Normal file
13
templates/index.md.tmpl
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# {{ .ProviderShortName | upper }} Provider
|
||||
|
||||
The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.
|
||||
|
||||
## Example Usage
|
||||
|
||||
{{ tffile "examples/provider/provider.tf" }}
|
||||
|
||||
## Authentication
|
||||
|
||||
Currently, only the *token flow* is supported. The Terraform provider will first try to find a token in the `STACKIT_SERVICE_ACCOUNT_TOKEN` env var. If not present, it will check the credentials file located in the path defined by the `STACKIT_CREDENTIALS_PATH` env var, if specified, or in `$HOME/.stackit/credentials.json` as a fallback. If the token is found, all the requests are authenticated using that token.
|
||||
|
||||
{{ .SchemaMarkdown | trimspace }}
|
||||
Loading…
Add table
Add a link
Reference in a new issue