Skip to content

Commit a194b3a

Browse files
authored
Adding doc requirements (#1282)
1 parent 6d6a5ca commit a194b3a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Contributing to Databricks Terraform Provider
22
---
33

44
- [Installing from source](#installing-from-source)
5+
- [Contributing documentation](#contributing-documentation)
56
- [Developing provider](#developing-provider)
67
- [Adding a new resource](#adding-a-new-resource)
78
- [Code conventions](#code-conventions)
@@ -29,6 +30,14 @@ make install
2930

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

33+
## Contributing documentation
34+
35+
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:
36+
37+
* `make fmt-docs` to make sure code examples are consistent
38+
* Correct rendering with Terraform Registry Doc Preview Tool - https://registry.terraform.io/tools/doc-preview
39+
* Cross-linking integrity between markdown files. Pay special attention, when resource doc refers to data doc or guide.
40+
3241
## Developing provider
3342

3443
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:

0 commit comments

Comments
 (0)