From 186b6dba2a4ca5099577ee10d04cf2b76f1cb7ad Mon Sep 17 00:00:00 2001 From: Tom Withers Date: Tue, 8 Jun 2021 21:10:55 +0100 Subject: [PATCH] Add some basic docs for the registry (#41) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Initial Pass at docs Co-authored-by: Matthias Bartelmeß --- website/docs/index.html.markdown | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 website/docs/index.html.markdown diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown new file mode 100644 index 00000000..63c24010 --- /dev/null +++ b/website/docs/index.html.markdown @@ -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.