Skip to content

Commit 6f667b7

Browse files
committed
docs(providers): Enhance front matter documentation
Signed-off-by: David Jetelina <[email protected]>
1 parent 322a95d commit 6f667b7

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

frontend/docs/providers/docs.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Additionally, if you would like to support CDKTF, you can create the following d
1717
- `/docs/cdktf/[python|typescript|csharp|java|go]/data-sources/<data-source>.md`
1818
- `/docs/cdktf/[python|typescript|csharp|java|go]/functions/<function>.md`
1919

20+
### Metadata
21+
2022
You can include the following header (front matter) in your markdown files:
2123

2224
```yaml
@@ -27,4 +29,16 @@ description: Description of the page
2729
---
2830
```
2931

30-
Once you have written your documentation, you can [proceed to publish your provider](/docs/providers/publishing).
32+
While you can put any metadata in the header, the following fields are used by the OpenTofu registry UI.
33+
34+
#### page_title
35+
36+
Title of the registry UI webpage (and some meta tags).
37+
38+
### description
39+
40+
Description, used in html meta tags in the registry UI.
41+
42+
### subcategory
43+
44+
Subcategory can be used to group resources, which is reflected in the UI sidebar. It adds categories in addition to the default `Resources`, `Datasources`, etc.

0 commit comments

Comments
 (0)