Skip to content

Commit

Permalink
Adding doc requirements (databricks#1282)
Browse files Browse the repository at this point in the history
  • Loading branch information
nfx authored Apr 29, 2022
1 parent 88be054 commit fb82c9f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Contributing to Databricks Terraform Provider
---

- [Installing from source](#installing-from-source)
- [Contributing documentation](#contributing-documentation)
- [Developing provider](#developing-provider)
- [Adding a new resource](#adding-a-new-resource)
- [Code conventions](#code-conventions)
Expand Down Expand Up @@ -29,6 +30,14 @@ make install

Most likely, `terraform init -upgrade -verify-plugins=false -lock=false` would be a very great command to use.

## Contributing documentation

All documentation contributions should be as detailed as possible and follow the [required format](https://www.terraform.io/registry/providers/docs). The following additional checks must also be valid:

* `make fmt-docs` to make sure code examples are consistent
* Correct rendering with Terraform Registry Doc Preview Tool - https://registry.terraform.io/tools/doc-preview
* Cross-linking integrity between markdown files. Pay special attention, when resource doc refers to data doc or guide.

## Developing provider

In order to simplify development workflow, you should use [dev_overrides](https://www.terraform.io/cli/config/config-file#development-overrides-for-provider-developers) section in your `~/.terraformrc` file. Please run `make build` and replace "provider-binary" with the path to `terraform-provider-databricks` executable in your current working directory:
Expand Down

0 comments on commit fb82c9f

Please sign in to comment.