Skip to content
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.

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

Migrate docs to registry-compatible structure #250

Merged
merged 21 commits into from
Aug 19, 2020
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
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
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/docs-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
name: Docs Issue
about: Use this to suggest enhancements or point out bugs for the documentation website.
title: "[DOC] Issue Short Description"
labels: ''
assignees: stikkireddy

labels: documentation
---

Hi there,
Expand All @@ -30,4 +28,4 @@ Any links to external documentation that may prove your case, i.e Databricks pub

### References
Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
- GH-1234
- #158
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feedback.md

This file was deleted.

10 changes: 2 additions & 8 deletions .github/ISSUE_TEMPLATE/provider-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
name: Provider Issue
about: Use this to identify a issue or a bug with the provider.
title: "[ISSUE] Issue Short Description"
labels: ''
assignees: stikkireddy

labels: bug
---

Hi there,
Expand Down Expand Up @@ -45,8 +43,4 @@ Please list the steps required to reproduce the issue, for example:
1. `terraform apply`

### Important Factoids
Are there anything atypical about your accounts that we should know? For example: Running in EC2 Classic? Custom version of OpenStack? Tight ACLs?

### References
Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
- GH-1234
Are there anything atypical about your accounts that we should know?
34 changes: 0 additions & 34 deletions .github/workflows/gh-pages.yml

This file was deleted.

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
# Created by https://www.gitignore.io/api/go,python,terraform,virtualenv,pycharm+iml,intellij+all,visualstudiocode
# Edit at https://www.gitignore.io/?templates=go,python,terraform,virtualenv,pycharm+iml,intellij+all,visualstudiocode

common/testdata/.azure

### Go ###
# Binaries for programs and plugins
*.exe
Expand Down
48 changes: 1 addition & 47 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ Contributing to Databricks Terraform Provider
- [Random naming anywhere](#random-naming-anywhere)
- [Integration Testing](#integration-testing)
- [Pre-release procedure](#pre-release-procedure)
- [Project Components](#project-components)
- [Databricks Terraform Provider Resources State](#databricks-terraform-provider-resources-state)
- [Databricks Terraform Data Sources State](#databricks-terraform-data-sources-state)

We happily welcome contributions to databricks-terraform. We use GitHub Issues to track community reported issues and GitHub Pull Requests for accepting changes.

Expand Down Expand Up @@ -191,47 +188,4 @@ crucial for making sure that the provider behaves as expected on all supported c
2. `make test-mws` if MWS related code changed given release.
3. Create release notes.
4. Perfrom backwards-compatibility checks and make proper notes.

## Project Components

### Databricks Terraform Provider Resources State

| Resource | Implemented | Import Support | Acceptance Tests | Documentation | Reviewed | Finalize Schema |
|----------------------------------|--------------------|----------------------|----------------------|----------------------|----------------------|----------------------|
| databricks_token | :white_check_mark: | :white_large_square: | :white_check_mark: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_secret_scope | :white_check_mark: | :white_large_square: | :white_check_mark: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_secret | :white_check_mark: | :white_large_square: | :white_check_mark: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_secret_acl | :white_check_mark: | :white_large_square: | :white_check_mark: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_instance_pool | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_scim_user | :white_check_mark: | :white_large_square: | :white_check_mark: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_scim_group | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_notebook | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_cluster | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_job | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_dbfs_file | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_dbfs_file_sync | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_instance_profile | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_aws_s3_mount | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_azure_blob_mount | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_azure_adls_gen1_mount | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |
| databricks_azure_adls_gen2_mount | :white_check_mark: | :white_large_square: | :white_large_square: | :white_check_mark: | :white_large_square: | :white_large_square: |

### Databricks Terraform Data Sources State

| Data Source | Implemented | Acceptance Tests | Documentation | Reviewed |
|-----------------------------|----------------------|----------------------|----------------------|----------------------|
| databricks_notebook | :white_check_mark: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_notebook_paths | :white_check_mark: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_dbfs_file | :white_check_mark: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_dbfs_file_paths | :white_check_mark: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_zones | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_runtimes | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_instance_pool | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_scim_user | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_scim_group | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_cluster | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_job | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_mount | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_instance_profile | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_database | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
| databricks_table | :white_large_square: | :white_large_square: | :white_large_square: | :white_large_square: |
5.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,32 @@

[![Build Status](https://travis-ci.org/databrickslabs/terraform-provider-databricks.svg?branch=master)](https://travis-ci.org/databrickslabs/terraform-provider-databricks) [![codecov](https://codecov.io/gh/databrickslabs/terraform-provider-databricks/branch/master/graph/badge.svg)](https://codecov.io/gh/databrickslabs/terraform-provider-databricks)

[Documentation](https://databrickslabs.github.io/terraform-provider-databricks/provider/) | [Contributing and Development Guidelines](CONTRIBUTING.md)
[Authentication](docs/index.md)
| [databricks_aws_s3_mount](docs/resources/aws_s3_mount.md)
| [databricks_azure_adls_gen1_mount](docs/resources/azure_adls_gen1_mount.md)
| [databricks_azure_adls_gen2_mount](docs/resources/azure_adls_gen2_mount.md)
| [databricks_azure_blob_mount](docs/resources/azure_blob_mount.md)
| [databricks_cluster](docs/resources/cluster.md)
| [databricks_cluster_policy](docs/resources/cluster_policy.md)
| [databricks_dbfs_file](docs/resources/dbfs_file.md)
| [databricks_group](docs/resources/group.md)
| [databricks_group_instance_profile](docs/resources/group_instance_profile.md)
| [databricks_group_member](docs/resources/group_member.md)
| [databricks_instance_pool](docs/resources/instance_pool.md)
| [databricks_instance_profile](docs/resources/instance_profile.md)
| [databricks_job](docs/resources/job.md)
| [databricks_mws_credentials](docs/resources/mws_credentials.md)
| [databricks_mws_networks](docs/resources/mws_networks.md)
| [databricks_mws_storage_configurations](docs/resources/mws_storage_configurations.md)
| [databricks_mws_workspaces](docs/resources/mws_workspaces.md)
| [databricks_notebook](docs/resources/notebook.md)
| [databricks_permissions](docs/resources/permissions.md)
| [databricks_scim_user](docs/resources/scim_user.md)
| [databricks_secret](docs/resources/secret.md)
| [databricks_secret_acl](docs/resources/secret_acl.md)
| [databricks_secret_scope](docs/resources/secret_scope.md)
| [databricks_token](docs/resources/token.md)
| [Contributing and Development Guidelines](CONTRIBUTING.md)

To quickly install the binary please execute the following curl command in your shell or [install provider from source](CONTRIBUTING.md#installing-from-source).

Expand Down Expand Up @@ -31,7 +56,7 @@ resource "databricks_cluster" "shared_autoscaling" {
}
```

Then run `terraform init` then `terraform apply` to apply the hcl code to your Databricks workspace. Please refer to the [end-user documentation](https://databrickslabs.github.io/terraform-provider-databricks/provider/) for detailed use of the provider. Also refer to these [examples](examples/) for more scenarios.
Then run `terraform init` then `terraform apply` to apply the hcl code to your Databricks workspace.

## Project Support
Please note that all projects in the /databrickslabs github account are provided for your exploration only, and are not formally supported by Databricks with Service Level Agreements (SLAs). They are provided AS-IS and we do not make any guarantees of any kind. Please do not submit a support ticket relating to any issues arising from the use of these projects.
Expand Down
25 changes: 4 additions & 21 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,18 @@
ignore:
- "client/**/*test.go"
- "databricks/*test.go"
- "vendor/**/*"
- "website/**/*"
- "dist/**/*"
- "examples/**/*"

coverage:
status:
project:
client:
target: auto
flags:
- client
provider:
target: auto
flags:
- provider
project: yes
patch: yes
changes: yes
comment:
layout: "reach, diff, flags, files"
behavior: default
require_changes: false # if true: only post the comment if coverage changes
require_base: yes # [yes :: must have a base report to post]
require_head: yes # [yes :: must have a head report to post]
branches: null # branch names that can post comment
flags:
client:
paths:
- "client/**/*.go"
carryforward: false
provider:
paths:
- "databricks/*.go"
carryforward: true
branches: null # branch names that can post comment
Loading