Skip to content

Add template for provider main page #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 11, 2023
Merged

Add template for provider main page #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
091adb2
Add template
Sep 11, 2023
571a913
Generate docs
Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit Provider"
subcategory: ""
description: |-

---

# stackit Provider
# STACKIT Provider

The STACKIT provider is the official Terraform provider to integrate all the resources developed by STACKIT.

# 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.


## Example Usage

```terraform
Expand All @@ -23,6 +10,10 @@ provider "stackit" {
}
```

## 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.

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
13 changes: 13 additions & 0 deletions templates/index.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 }}