Skip to content

Commit fbc2963

Browse files
justinretzolkrainkwan
authored andcommitted
Minor formatting update to README
1 parent 851cf43 commit fbc2963

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ Otherwise, the provider developer can set an arbitrary description like this:
165165

166166
The `validate` subcommand can be used to validate the provider website documentation against the [Terraform Registry's provider documentation guidelines](https://developer.hashicorp.com/terraform/registry/providers/docs) and provider documentation best practices. The current checks in the `validate` command are:
167167
168-
| Check | Description |
169-
|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
170-
| `InvalidDirectoriesCheck` | Checks for valid subdirectory structure and throws an error if an invalid Terraform Provider documentation subdirectory is found. |
171-
| `MixedDirectoriesCheck` | Throws an error if both legacy documentation (`/website/docs`) and registry documentation (`/docs`) are found. |
172-
| `FileSizeCheck` | Throws an error if the documentation file is above the registry storage limit. |
173-
| `FileExtensionCheck` | Throws an error if the extension of the given file is not a valid registry documentation extension. |
174-
| `FrontMatterCheck` | Checks the YAML frontmatter of documentation for missing required fields or invalid fields. Optionally, checks that the `subcategory` is within the specified allow list. |
175-
| `FileMismatchCheck` | Throws an error if the names/number of resources/datasources/functions in the provider schema does not match the names/number of files in the corresponding documentation directory.|
168+
| Check | Description |
169+
|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
170+
| `InvalidDirectoriesCheck` | Checks for valid subdirectory structure and throws an error if an invalid Terraform Provider documentation subdirectory is found. |
171+
| `MixedDirectoriesCheck` | Throws an error if both legacy documentation (`/website/docs`) and registry documentation (`/docs`) are found. |
172+
| `FileSizeCheck` | Throws an error if the documentation file is above the registry storage limit. |
173+
| `FileExtensionCheck` | Throws an error if the extension of the given file is not a valid registry documentation extension. |
174+
| `FrontMatterCheck` | Checks the YAML frontmatter of documentation for missing required fields or invalid fields. Optionally, checks that the `subcategory` is within the specified allow list. |
175+
| `FileMismatchCheck` | Throws an error if the names/number of resources/datasources/functions in the provider schema does not match the names/number of files in the corresponding documentation directory. |
176176
177177
All check errors are wrapped and returned as a single error message to stderr.
178178

0 commit comments

Comments
 (0)