Skip to content

Commit

Permalink
doc: add doc-preview to the CONTRIBUTING.md (#1945)
Browse files Browse the repository at this point in the history
  • Loading branch information
andreaangiolillo authored Feb 14, 2024
1 parent 6194665 commit c6f0405
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ Note: you can override the Open API description of a field with a custom descrip
## Documentation Best Practices

- In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: [cloud_backup_schedule.html.markdown](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/r/cloud_backup_schedule.html.markdown?plain=1#L207)
- You can check how the documentation is rendered on the Terraform Registry via [doc-preview](https://registry.terraform.io/tools/doc-preview).

### Creating Resource and Data source Documentation
We autogenerate the documentation of our provider resources and data sources via [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs).
Expand Down

0 comments on commit c6f0405

Please sign in to comment.