diff --git a/docs/_index.md b/docs/_index.md index ea5d7d9..a854b97 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -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" --- diff --git a/docs/developer-guide/contributing.md b/docs/developer-guide/contributing.md index 1665d0a..0451144 100644 --- a/docs/developer-guide/contributing.md +++ b/docs/developer-guide/contributing.md @@ -1,6 +1,6 @@ --- title: "Contributing" -description: "terraform-docs contributing guide." +description: "terraform-docs contributing guide" menu: docs: parent: "developer-guide" diff --git a/docs/developer-guide/plugins.md b/docs/developer-guide/plugins.md index eded9a1..ed00e4e 100644 --- a/docs/developer-guide/plugins.md +++ b/docs/developer-guide/plugins.md @@ -1,6 +1,6 @@ --- title: "Plugins" -description: "terraform-docs plugin development guide." +description: "terraform-docs plugin development guide" menu: docs: parent: "developer-guide" diff --git a/docs/how-to/cli-flag-false-value.md b/docs/how-to/cli-flag-false-value.md index 4f22dcf..9415d2e 100644 --- a/docs/how-to/cli-flag-false-value.md +++ b/docs/how-to/cli-flag-false-value.md @@ -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" diff --git a/docs/how-to/configuration-file.md b/docs/how-to/configuration-file.md index c2c66d3..b38ab73 100644 --- a/docs/how-to/configuration-file.md +++ b/docs/how-to/configuration-file.md @@ -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" diff --git a/docs/how-to/generate-terraform-tfvars.md b/docs/how-to/generate-terraform-tfvars.md index 615bb9c..fe0f126 100644 --- a/docs/how-to/generate-terraform-tfvars.md +++ b/docs/how-to/generate-terraform-tfvars.md @@ -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" diff --git a/docs/how-to/github-action.md b/docs/how-to/github-action.md index 0dad451..a23c168 100644 --- a/docs/how-to/github-action.md +++ b/docs/how-to/github-action.md @@ -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" diff --git a/docs/how-to/include-examples.md b/docs/how-to/include-examples.md index aeee419..fb1965e 100644 --- a/docs/how-to/include-examples.md +++ b/docs/how-to/include-examples.md @@ -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" diff --git a/docs/how-to/insert-output-to-file.md b/docs/how-to/insert-output-to-file.md index 7cef4af..54f11a0 100644 --- a/docs/how-to/insert-output-to-file.md +++ b/docs/how-to/insert-output-to-file.md @@ -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" diff --git a/docs/how-to/pre-commit-hooks.md b/docs/how-to/pre-commit-hooks.md index 8d3076e..3bb1e67 100644 --- a/docs/how-to/pre-commit-hooks.md +++ b/docs/how-to/pre-commit-hooks.md @@ -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" diff --git a/docs/how-to/recursive-submodules.md b/docs/how-to/recursive-submodules.md index 012f272..834e8e4 100644 --- a/docs/how-to/recursive-submodules.md +++ b/docs/how-to/recursive-submodules.md @@ -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" diff --git a/docs/how-to/visibility-of-sections.md b/docs/how-to/visibility-of-sections.md index bc98aa5..a6f4af1 100644 --- a/docs/how-to/visibility-of-sections.md +++ b/docs/how-to/visibility-of-sections.md @@ -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" diff --git a/docs/reference/asciidoc-document.md b/docs/reference/asciidoc-document.md index e836bd8..4a64885 100644 --- a/docs/reference/asciidoc-document.md +++ b/docs/reference/asciidoc-document.md @@ -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" diff --git a/docs/reference/asciidoc-table.md b/docs/reference/asciidoc-table.md index 49257a6..7737ff7 100644 --- a/docs/reference/asciidoc-table.md +++ b/docs/reference/asciidoc-table.md @@ -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" diff --git a/docs/reference/asciidoc.md b/docs/reference/asciidoc.md index 5274cea..f82ef3e 100644 --- a/docs/reference/asciidoc.md +++ b/docs/reference/asciidoc.md @@ -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" diff --git a/docs/reference/json.md b/docs/reference/json.md index 4620c20..8cf020a 100644 --- a/docs/reference/json.md +++ b/docs/reference/json.md @@ -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" diff --git a/docs/reference/markdown-document.md b/docs/reference/markdown-document.md index b5e6ef3..3859beb 100644 --- a/docs/reference/markdown-document.md +++ b/docs/reference/markdown-document.md @@ -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" diff --git a/docs/reference/markdown-table.md b/docs/reference/markdown-table.md index 74ee7a6..2167b25 100644 --- a/docs/reference/markdown-table.md +++ b/docs/reference/markdown-table.md @@ -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" diff --git a/docs/reference/markdown.md b/docs/reference/markdown.md index 13e72fb..bd2d944 100644 --- a/docs/reference/markdown.md +++ b/docs/reference/markdown.md @@ -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" diff --git a/docs/reference/pretty.md b/docs/reference/pretty.md index af44604..dc4fef7 100644 --- a/docs/reference/pretty.md +++ b/docs/reference/pretty.md @@ -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" diff --git a/docs/reference/terraform-docs.md b/docs/reference/terraform-docs.md index 9176d27..97e8de3 100644 --- a/docs/reference/terraform-docs.md +++ b/docs/reference/terraform-docs.md @@ -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" diff --git a/docs/reference/tfvars-hcl.md b/docs/reference/tfvars-hcl.md index 2664a2e..e7b2354 100644 --- a/docs/reference/tfvars-hcl.md +++ b/docs/reference/tfvars-hcl.md @@ -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" diff --git a/docs/reference/tfvars-json.md b/docs/reference/tfvars-json.md index 2b1f823..e0e4184 100644 --- a/docs/reference/tfvars-json.md +++ b/docs/reference/tfvars-json.md @@ -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" diff --git a/docs/reference/tfvars.md b/docs/reference/tfvars.md index b872d0c..4721b00 100644 --- a/docs/reference/tfvars.md +++ b/docs/reference/tfvars.md @@ -1,6 +1,6 @@ --- title: "tfvars" -description: "Generate terraform.tfvars of inputs." +description: "Generate terraform.tfvars of inputs" menu: docs: parent: "terraform-docs" diff --git a/docs/reference/toml.md b/docs/reference/toml.md index 372713e..b321db8 100644 --- a/docs/reference/toml.md +++ b/docs/reference/toml.md @@ -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" diff --git a/docs/reference/xml.md b/docs/reference/xml.md index 67503b6..df98dc4 100644 --- a/docs/reference/xml.md +++ b/docs/reference/xml.md @@ -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" diff --git a/docs/reference/yaml.md b/docs/reference/yaml.md index cb7f2fd..11f9c1a 100644 --- a/docs/reference/yaml.md +++ b/docs/reference/yaml.md @@ -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" diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md index 65b857d..f16882d 100644 --- a/docs/user-guide/installation.md +++ b/docs/user-guide/installation.md @@ -1,6 +1,6 @@ --- title: "Installation" -description: "terraform-docs installation guide." +description: "terraform-docs installation guide" menu: docs: parent: "user-guide" diff --git a/docs/user-guide/introduction.md b/docs/user-guide/introduction.md index b3c8ef1..a61fd84 100644 --- a/docs/user-guide/introduction.md +++ b/docs/user-guide/introduction.md @@ -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" diff --git a/scripts/docs/format.tmpl b/scripts/docs/format.tmpl index 4e14c34..246f2e7 100644 --- a/scripts/docs/format.tmpl +++ b/scripts/docs/format.tmpl @@ -1,6 +1,6 @@ --- title: "{{ .Name }}" -description: "{{ .Description }}." +description: "{{ .Description }}" menu: docs: parent: "{{ .Parent }}"