atlassian#14: Cleanup existing docs and add initial website (atlassia…

…n#17)

CONTRIBUTING.md → .github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Reporting Issues
 
-This section guides you through submitting a bug report for go-artifactory. Following these guidelines helps us and the community understand your issue, reproduce the behavior, and find related issues.
+This section guides you through submitting a bug report for terraform-provider-artifactory. Following these guidelines helps us and the community understand your issue, reproduce the behavior, and find related issues.
 
 When you are creating an issue, please include as many details as possible.
 
@@ -33,7 +33,7 @@ Please raise a new issue [here][IssueTracker].
 
 ### Follow code style guidelines
 
-It is recommended you use the git hooks found in the misc directory, this will include go-fmt
+This includes running go fmt on modified files
 
 ## Merge into master
 All new feature code must be completed in a feature branch and have a corresponding Feature or Bug issue in the go-artifactory project.
@@ -58,4 +58,4 @@ go-artifactory endeavours to avoid external dependencies.
 ## Make changes to the Pipelines build
 go-stride uses Bitbucket Pipelines for it's continuous integration. The build scripts are defined in `bitbucket-pipelines.yml`.
 
-[IssueTracker]: https://github.com/atlassian/go-artifactory/issues
+[IssueTracker]: https://github.com/atlassian/terraform-provider-artifactory/issues

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,21 +1,86 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: 🐛 Bug Report
+about: If something isn't working as expected 🤔.
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+<!---
+Please note the following potential times when an issue might be in Terraform core:
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+* [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues
+* [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues
+* [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues
+* [Registry](https://registry.terraform.io/) issues
+* Spans resources across multiple providers
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+If you are running into one of these scenarios, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead.
+--->
 
-**Additional context**
-Add any other context about the problem here.
+<!--- Please keep this note for the community --->
+
+### Community Note
+
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
+
+<!--- Thank you for keeping this note for the community --->
+
+### Terraform Version
+
+<!--- Please run `terraform -v` to show the Terraform core version and provider version(s). If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions). --->
+
+### Affected Resource(s)
+
+<!--- Please list the affected resources and data sources. --->
+
+* artifactory_XXXXX
+
+### Terraform Configuration Files
+
+<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
+
+```hcl
+# Copy-paste your Terraform configurations here - for large Terraform configs,
+# please use a service like Dropbox and share a link to the ZIP file.
+```
+
+### Debug Output
+
+<!---
+Please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist.
+
+To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html).
+--->
+
+### Panic Output
+
+<!--- If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`. --->
+
+### Expected Behavior
+
+<!--- What should have happened? --->
+
+### Actual Behavior
+
+<!--- What actually happened? --->
+
+### Steps to Reproduce
+
+<!--- Please list the steps required to reproduce the issue. --->
+
+1. `terraform apply`
+
+### Important Factoids
+
+<!--- Are there anything atypical about your accounts that we should know? For example: Running in EC2 Classic? --->
+
+### References
+
+<!---
+Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
+
+Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? For example:
+--->
+
+* #0000

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,47 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: 🚀 Feature Request
+about: I have a suggestion (and might want to implement myself 🙂)!
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--- Please keep this note for the community --->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+### Community Note
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!--- Thank you for keeping this note for the community --->
+
+### Description
+
+<!--- Please leave a helpful description of the feature request here. --->
+
+### New or Affected Resource(s)
+
+<!--- Please list the new or affected resources and data sources. --->
+
+* artifactory_XXXXX
+
+### Potential Terraform Configuration
+
+<!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
+
+```hcl
+# Copy-paste your Terraform configurations here - for large Terraform configs,
+# please use a service like Dropbox and share a link to the ZIP file. For
+# security, you can also encrypt the files using our GPG public key.
+```
+
+### References
+
+<!---
+Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
+
+Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
+
+* https://aws.amazon.com/about-aws/whats-new/2018/04/introducing-amazon-ec2-fleet/
+--->
+
+* #0000

CHANGELOG.md

@@ -0,0 +1,19 @@
+## 1.5.0 (Unreleased)
+
+FEATURES:
+* Added docs website
+
+## 1.4.1 (November 6, 2018)
+BREAKING CHANGES:
+* Removed makefile and githooks in favour of default go tool commands.
+
+FEATURES:
+* Add support for supplying user password on creation via the environment variable:
+
+  ```TF_USER_${artifactory_username_here}_PASSWORD```
+
+  This variable may change and is not tracked by terraform
+
+NOTES:
+* Removed formatting checks from CI and streamlined build.
+* Migrate from dep to go modules. This is transparent for consumers but requires go 1.11+ for development.

README.md

@@ -4,10 +4,8 @@
 If you're building the provider, follow the instructions to [install it as a plugin.](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin) After placing it into your plugins directory,  run `terraform init` to initialize it.
 
 ## Requirements ##
--	[Terraform](https://www.terraform.io/downloads.html) 0.10
--	[Go](https://golang.org/doc/install) 1.9 (to build the provider plugin)
--   [Dep](https://github.com/golang/dep/releases) 0.3.2 (for dependency management)
-
+-	[Go](https://golang.org/doc/install) 1.10+ (to build the provider plugin)
+-	[Terraform](https://www.terraform.io/downloads.html) 0.11
 
 ## Building The Provider ##
 
@@ -83,5 +81,5 @@ those contributing as an individual.
 Copyright (c) 2017 Atlassian and others. Apache 2.0 licensed, see [LICENSE][LICENSE] file.
 
 
-[CONTRIBUTING]: ./CONTRIBUTING.md
+[CONTRIBUTING]: .github/CONTRIBUTING.md
 [LICENSE]: ./LICENSE.txt

docs/index.md

@@ -0,0 +1,37 @@
+# Artifactory Provider
+
+The [Artifactory](https://jfrog.com/artifactory/) provider is used to interact with the
+resources supported by Artifactory. The provider needs to be configured
+with the proper credentials before it can be used.
+
+- Available Resources
+    * [Groups](r/group.md)
+
+
+## Example Usage
+
+```hcl
+# Configure the Artifactory provider
+provider "artifactory" {
+  url = "${var.artifactory_url}"
+  username = "${var.artifactory_username}"
+  password = "${var.artifactory_password}"
+}
+
+# Create a new repository
+resource "artifactory_local_repository" "pypi-libs" {
+  key             = "pypi-libs"
+  package_type    = "pypi"
+  repo_layout_ref = "simple-default"
+  description     = "A pypi repository for python packages"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `url`      - (Required) URL of Artifactory. This can also be set via the `ARTIFACTORY_URL` environment variable.
+* `username` - (Optional) Username for basic auth. Requires `password` to be set. Conflicts with `token`. This can also be set via the `ARTIFACTORY_USERNAME` environment variable.
+* `password` - (Optional) Password for basic auth. Requires `username` to be set. Conflicts with `token`. This can also be set via the `ARTIFACTORY_PASSWORD` environment variable.
+* `username` - (Optional) API key for token auth. Uses `X-JFrog-Art-Api` header. Conflicts with `username` and `password`. This can also be set via the `ARTIFACTORY_TOKEN` environment variable.

docs/r/group.md

@@ -0,0 +1,33 @@
+# artifactory_group
+
+Provides an Artifactory group resource. This can be used to create and manage Artifactory groups.
+
+## Example Usage
+
+```hcl
+# Create a new Artifactory group called terraform
+resource "artifactory_group" "test-group" {
+	name             = "terraform"
+    description 	 = "test group"
+	admin_privileges = false
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `name`                - (Required) Name of the group
+* `description`         - (Optional) A description for the group
+* `auto_join`           - (Optional) When this parameter is set, any new users defined in the system are automatically assigned to this group.
+* `admin_privileges`    - (Optional) Any users added to this group will automatically be assigned with admin privileges in the system.
+* `realm`               - (Optional) The realm for the group.
+* `realm_attributes`    - (Optional) The realm attributes for the group.
+
+## Import
+
+Groups can be imported using their name, e.g.
+
+```
+$ terraform import artifactory_group.terraform-group mygroup
+```