Skip to content

Commit

Permalink
Add some basic docs for the registry (#41)
Browse files Browse the repository at this point in the history
* Initial Pass at docs

Co-authored-by: Matthias Bartelmeß <mba@fourplusone.de>
  • Loading branch information
TomTucka and fourplusone committed Jun 8, 2021
1 parent 896967e commit 186b6db
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: "jira"
page_title: "Provider: Jira"
description: |-
The Jira provider provides resources to interact with and manage Jira.
---

# Jira Provider

The Jira provider provides resources to interact with and manage Jira projects.

## Example Usage

Terraform 0.13 and later:

```terraform
terraform {
required_providers {
jira = {
source = "fourplusone/jira"
version = "0.1.15"
}
}
}
# Configure the Jira Provider
provider "jira" {
url = "https://myjira.atlassian.net" # Can also be set using the JIRA_URL environment variable
user = "xxxx" # Can also be set using the JIRA_USER environment variable
password = "xxxx" # Can also be set using the JIRA_PASSWORD environment variable
}
```

## Schema

- **url** (String, Required) URL for your Jira instance. Can be specified with the JIRA_URL environment variable.

- **user** (String, Required) Username for your user. Can be specified with the JIRA_USER environment variable.

- **password** (String, Required) Password for the user, can also be an API Token. Can be specified with the JIRA_PASSWORD environment variable.

0 comments on commit 186b6db

Please sign in to comment.