Skip to content

Commit

Permalink
docs: restructure and streamline documentation (#1003)
Browse files Browse the repository at this point in the history
## Description

This PR restructures the whole documentation and adapts it to the
changed variable names introduces with v7 release.

- shorten the main document
- underline that contributions are welcome
- create a pitfall document
- moving the detailed concepts into a separate file
  • Loading branch information
kayman-mk authored Oct 5, 2023
1 parent 9a6458a commit 8348f80
Show file tree
Hide file tree
Showing 4 changed files with 408 additions and 448 deletions.
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Contribution guide

We appreciate your thought to contribute to open source. :heart: We want to make contributing as easy as possible. You are welcome to:
We appreciate your thought to contribute to open source. :heart: We want to make contributing as easy as possible.
You are welcome to:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Report a bug
- Discuss the current state of the code
- Submit a fix
- Propose new features

We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
We use [Github Flow](https://guides.github.com/introduction/flow/index.html), So all code changes happen through pull requests.
We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code, check one of the examples.
Expand All @@ -25,7 +26,8 @@ We use the [Terraform Style conventions](https://www.terraform.io/docs/configura

## Documentation

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.
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

Expand Down
Loading

0 comments on commit 8348f80

Please sign in to comment.