Skip to content

Commit

Permalink
docs: auto docs are not available anymore (#304)
Browse files Browse the repository at this point in the history
* docs: auto docs are not available anymore

* docs: add new documentation workflow
  • Loading branch information
stefan-kolb committed Feb 23, 2021
1 parent c3629f6 commit 532eb0b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
6. Issue that pull request!

## Coding Style
We use the [Terraform Style conventions](https://www.terraform.io/docs/configuration/style.html). They are enforced with ci scripts.
We use the [Terraform Style conventions](https://www.terraform.io/docs/configuration/style.html). They are enforced with CI scripts.

## Documentation
The README.md in the root is generated by a manual script in `ci/bin/autodocs.sh`. The script generate the variable tables, merge the in the README.md file based on the file in the `_docs` folder.
We use [pre-commit](https://pre-commit.com/) to update the Terraform inputs and outputs in the documentation via [terraform-docs](https://github.com/terraform-docs/terraform-docs). Ensure you have installed those components.

## Testing
No automated tests are available. The example directory takes care of a few scenario's.
Expand Down

0 comments on commit 532eb0b

Please sign in to comment.