-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add contributor guide local development setup
- Loading branch information
Showing
1 changed file
with
19 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,21 @@ | ||
# Documentation | ||
|
||
- [Using the AWS Provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | ||
- [AWS Provider contributing guide](https://hashicorp.github.io/terraform-provider-aws/) | ||
This directory contains documentation for the [Terraform AWS Provider Contributor Guide](https://hashicorp.github.io/terraform-provider-aws/). Resource and data source documentation is located in the [`website`](../website/) directory and available in the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest/docs). | ||
|
||
## Local Development | ||
|
||
To serve the contributing guide locally, [`mkdocs`](https://www.mkdocs.org/user-guide/installation/) and the [`mkdocs-material`](https://github.com/squidfunk/mkdocs-material#quick-start) extension must be installed. Both require Python and `pip`. | ||
|
||
```console | ||
% pip3 install mkdocs | ||
``` | ||
|
||
```console | ||
% pip3 install mkdocs-material | ||
``` | ||
|
||
Once installed, the documentation can be served from the root directory: | ||
|
||
```console | ||
% mkdocs serve | ||
``` |