mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
Cleanup documentations
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title : "terraform-docs"
|
||||
description: "Generate Terraform modules documentation in various formats."
|
||||
lead: "Generate Terraform modules documentation in various formats."
|
||||
description: "Generate Terraform modules documentation in various formats"
|
||||
lead: "Generate Terraform modules documentation in various formats"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Contributing"
|
||||
description: "terraform-docs contributing guide."
|
||||
description: "terraform-docs contributing guide"
|
||||
menu:
|
||||
docs:
|
||||
parent: "developer-guide"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Plugins"
|
||||
description: "terraform-docs plugin development guide."
|
||||
description: "terraform-docs plugin development guide"
|
||||
menu:
|
||||
docs:
|
||||
parent: "developer-guide"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "CLI Flag 'false' value"
|
||||
description: "How to use pass 'false' value to terraform-docs CLI flags."
|
||||
description: "How to use pass 'false' value to terraform-docs CLI flags"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Configuration File"
|
||||
description: "How to use terraform-docs configuration file."
|
||||
description: "How to use terraform-docs configuration file"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Generate terraform.tfvars"
|
||||
description: "How to generate terraform.tfvars file with terraform-docs."
|
||||
description: "How to generate terraform.tfvars file with terraform-docs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "GitHub Action"
|
||||
description: "How to use terraform-docs with GitHub Actions."
|
||||
description: "How to use terraform-docs with GitHub Actions"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Include Examples"
|
||||
description: "How to include example in terraform-docs generated output."
|
||||
description: "How to include example in terraform-docs generated output"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Insert Output To File"
|
||||
description: "How to insert generated terraform-docs output to file."
|
||||
description: "How to insert generated terraform-docs output to file"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "pre-commit Hooks"
|
||||
description: "How to use pre-commit hooks with terraform-docs."
|
||||
description: "How to use pre-commit hooks with terraform-docs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Recursive Submodules"
|
||||
description: "How to generate submodules documentation recursively with terraform-docs."
|
||||
description: "How to generate submodules documentation recursively with terraform-docs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Visibility of Sections"
|
||||
description: "How to control visibility of terraform-docs sections."
|
||||
description: "How to control visibility of terraform-docs sections"
|
||||
menu:
|
||||
docs:
|
||||
parent: "how-to"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "asciidoc document"
|
||||
description: "Generate AsciiDoc document of inputs and outputs."
|
||||
description: "Generate AsciiDoc document of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "asciidoc"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "asciidoc table"
|
||||
description: "Generate AsciiDoc tables of inputs and outputs."
|
||||
description: "Generate AsciiDoc tables of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "asciidoc"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "asciidoc"
|
||||
description: "Generate AsciiDoc of inputs and outputs."
|
||||
description: "Generate AsciiDoc of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "json"
|
||||
description: "Generate JSON of inputs and outputs."
|
||||
description: "Generate JSON of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "markdown document"
|
||||
description: "Generate Markdown document of inputs and outputs."
|
||||
description: "Generate Markdown document of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "markdown"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "markdown table"
|
||||
description: "Generate Markdown tables of inputs and outputs."
|
||||
description: "Generate Markdown tables of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "markdown"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "markdown"
|
||||
description: "Generate Markdown of inputs and outputs."
|
||||
description: "Generate Markdown of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "pretty"
|
||||
description: "Generate colorized pretty of inputs and outputs."
|
||||
description: "Generate colorized pretty of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "terraform-docs"
|
||||
description: "A utility to generate documentation from Terraform modules in various output formats."
|
||||
description: "A utility to generate documentation from Terraform modules in various output formats"
|
||||
menu:
|
||||
docs:
|
||||
parent: "reference"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "tfvars hcl"
|
||||
description: "Generate HCL format of terraform.tfvars of inputs."
|
||||
description: "Generate HCL format of terraform.tfvars of inputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "tfvars"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "tfvars json"
|
||||
description: "Generate JSON format of terraform.tfvars of inputs."
|
||||
description: "Generate JSON format of terraform.tfvars of inputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "tfvars"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "tfvars"
|
||||
description: "Generate terraform.tfvars of inputs."
|
||||
description: "Generate terraform.tfvars of inputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "toml"
|
||||
description: "Generate TOML of inputs and outputs."
|
||||
description: "Generate TOML of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "xml"
|
||||
description: "Generate XML of inputs and outputs."
|
||||
description: "Generate XML of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "yaml"
|
||||
description: "Generate YAML of inputs and outputs."
|
||||
description: "Generate YAML of inputs and outputs"
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Installation"
|
||||
description: "terraform-docs installation guide."
|
||||
description: "terraform-docs installation guide"
|
||||
menu:
|
||||
docs:
|
||||
parent: "user-guide"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Introduction"
|
||||
description: "Generate documentation from Terraform modules in various output formats."
|
||||
description: "Generate documentation from Terraform modules in various output formats"
|
||||
menu:
|
||||
docs:
|
||||
parent: "user-guide"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "{{ .Name }}"
|
||||
description: "{{ .Description }}."
|
||||
description: "{{ .Description }}"
|
||||
menu:
|
||||
docs:
|
||||
parent: "{{ .Parent }}"
|
||||
|
||||
Reference in New Issue
Block a user