mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
Add developer-guide documentation
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
12
docs/developer-guide/contributing.md
Normal file
12
docs/developer-guide/contributing.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "Contributing"
|
||||
description: "terraform-docs contributing guide."
|
||||
menu:
|
||||
docs:
|
||||
parent: "developer-guide"
|
||||
weight: 220
|
||||
toc: true
|
||||
---
|
||||
|
||||
Check [CONTRIBUTING.md](https://git.io/JtEzg) file on the root of our repository
|
||||
for more details.
|
||||
20
docs/developer-guide/plugins.md
Normal file
20
docs/developer-guide/plugins.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: "Plugins"
|
||||
description: "terraform-docs plugin development guide."
|
||||
menu:
|
||||
docs:
|
||||
parent: "developer-guide"
|
||||
weight: 210
|
||||
toc: true
|
||||
---
|
||||
|
||||
If you want to add or change formatter, you need to write plugins. When changing
|
||||
plugins, refer to the repository of each plugin and refer to how to build and
|
||||
install.
|
||||
|
||||
If you want to create a new plugin, please refer to [tfdocs-format-template]. The
|
||||
plugin can use [plugin-sdk] to communicate with the host process. You can create a
|
||||
new repository from `Use this template`.
|
||||
|
||||
[tfdocs-format-template]: https://github.com/terraform-docs/tfdocs-format-template
|
||||
[plugin-sdk]: https://github.com/terraform-docs/plugin-sdk
|
||||
Reference in New Issue
Block a user