Skip to content

Commit

Permalink
Other: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
YakDriver committed Oct 14, 2021
1 parent ca58cc2 commit 6fe30af
Show file tree
Hide file tree
Showing 25 changed files with 492 additions and 338 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--- See what makes a good Pull Request at : https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/CONTRIBUTING.md --->
<!--- See what makes a good Pull Request at : https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing --->

<!--- Please keep this note for the community --->

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
body: |-
Thank you for your contribution! :rocket:
Please note that the `CHANGELOG.md` file contents are handled by the maintainers during merge. This is to prevent pull request merge conflicts, especially for contributions which may not be merged immediately. Please see the [Contributing Guide](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/CONTRIBUTING.md) for additional pull request review items.
Please note that the `CHANGELOG.md` file contents are handled by the maintainers during merge. This is to prevent pull request merge conflicts, especially for contributions which may not be merged immediately. Please see the [Contributing Guide](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing) for additional pull request review items.
Remove any changes to the `CHANGELOG.md` file and commit them in this pull request to prevent delays with reviewing and potentially merging this pull request.
misspell:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pull_requests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ jobs:
pr-message: |-
Welcome @${{github.actor}} :wave:
It looks like this is your first Pull Request submission to the [Terraform AWS Provider](https://github.com/hashicorp/terraform-provider-aws)! If you haven’t already done so please make sure you have checked out our [CONTRIBUTING](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/CONTRIBUTING.md) guide and [FAQ](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/FAQ.md) to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.
It looks like this is your first Pull Request submission to the [Terraform AWS Provider](https://github.com/hashicorp/terraform-provider-aws)! If you haven’t already done so please make sure you have checked out our [CONTRIBUTING](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing) guide and [FAQ](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing/faq.md) to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.
Also take a look at our [FAQ](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/FAQ.md) which details how we prioritize Pull Requests for inclusion.
Also take a look at our [FAQ](https://github.com/hashicorp/terraform-provider-aws/blob/main/docs/contributing/faq.md) which details how we prioritize Pull Requests for inclusion.
Thanks again, and welcome to the community! :smiley:
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Please note: We take Terraform's security and our users' trust very seriously. I
## Quick Starts

- [Using the provider](https://www.terraform.io/docs/providers/aws/index.html)
- [Provider development](docs/DEVELOPMENT.md)
- [Provider development](docs/contributing)

## Documentation

Expand All @@ -37,10 +37,10 @@ Our roadmap for expanding support in Terraform for AWS resources can be found in

## Frequently Asked Questions

Responses to our most frequently asked questions can be found in our [FAQ](docs/FAQ.md )
Responses to our most frequently asked questions can be found in our [FAQ](docs/contributing/faq.md )

## Contributing

The Terraform AWS Provider is the work of thousands of contributors. We appreciate your help!

To contribute, please read the contribution guidelines: [Contributing to Terraform - AWS Provider](docs/CONTRIBUTING.md)
To contribute, please read the contribution guidelines: [Contributing to Terraform - AWS Provider](docs/contributing)
2 changes: 1 addition & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Every few months, the team will highlight areas of focus for our work and upcoming research.

We select items for inclusion in the roadmap from the Top 10 Community Issues, [Core Services](docs/CORE_SERVICES.md), and internal priorities. Where community sourced contributions exist we will work with the authors to review and merge their work. Where this does not exist or the original contributors are not available we will create the resources and implementation ourselves.
We select items for inclusion in the roadmap from the Top 10 Community Issues, [Core Services](docs/contributing/core-services.md), and internal priorities. Where community sourced contributions exist we will work with the authors to review and merge their work. Where this does not exist or the original contributors are not available we will create the resources and implementation ourselves.

Each weekly release will include necessary tasks that lead to the completion of the stated goals as well as community pull requests, enhancements, and features that are not highlighted in the roadmap. To view all the items we've prioritized for this quarter, please see the [Roadmap milestone](https://github.com/hashicorp/terraform-provider-aws/milestone/138).

Expand Down
25 changes: 0 additions & 25 deletions docs/CONTRIBUTING.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Terraform AWS Provider Engineering Documentation

Looking for documentation? You've come to the right place.

* Documentation on [_using_ the Terraform AWS Provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
* [Road maps](roadmaps/README.md) showing the future direction of the AWS Provider
* Documentation on [contributing](contributing/) to the the AWS Provider!
30 changes: 30 additions & 0 deletions docs/contributing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to the Terraform AWS Provider

**First,** if you're unsure or afraid of _anything_, ask for help! You can open a draft pull request (PR) or an issue with what you know. We'll do our best to guide you in the right direction, and let you know if there are guidelines to follow. We want people to be able to participate without fear of doing the wrong thing.

**Second,** not all of this documentation is up-to-date. If you see something that's not quite right, please submit a PR. Documentation-only PRs are often merged more quickly than code.

**Third,** we don't always respond as quickly as we'd like. There's a lot going on. We prioritize certain aspects of the codebase but those priorities do shift over time. If we haven't gotten to something you find important, it's likely it's on our radar. We're working through other priorities to get to it.

To improve the review and merge process, please do your best to follow the documentation. Below are our expectations for contributors. Following these guidelines gives us the best opportunity to work with you, by making sure we have the things we need in order to make it happen. Doing your best to follow it will speed up our ability to merge PRs and respond to issues.

## Getting Started

- [Set Up Your Development Environment](development-environment.md)
- [FAQ](faq.md)
- [Core Services](core-services.md)
- [Provider Design](provider-design.md)

## Process

- [Contribution Types and Checklists](contribution-checklists.md)
- [Issue Reporting and Lifecycle](issue-reporting-and-lifecycle.md)
- [Maintainers and Maintaining the Repository](maintaining.md)
- [Pull Request Submission and Lifecycle](pullrequest-submission-and-lifecycle.md)

## Reference

- [Acceptance Tests, Running and Writing](running-and-writing-acceptance-tests.md)
- [Data Handling and Conversion](data-handling-and-conversion.md)
- [Error Handling](error-handling.md)
- [Retries and Waiters](retries-and-waiters.md)
Loading

0 comments on commit 6fe30af

Please sign in to comment.