Thanks to visit codestin.com
Credit goes to github.com

Skip to content

auto-populate a {{ .Examples }} from the examples directory #617

Open
@shawnrushefsky

Description

@shawnrushefsky

What problem are you facing?

I would like to use an ./examples directory as prescribed by the standard module structure.

The documentation suggests using include:

  {{ include "examples/example1/main.tf" }}

This definitely works and is still pretty easy. However, since the examples directory is a standard, it would be cool to have that part automatically generated as well, and made available to content via {{ .Examples }}.

How could terraform-docs help solve your problem?

Automatically recognizing the /examples directory and using its contents for an "Examples" section of the documentation.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions