Skip to content

Commit

Permalink
docs: add contributor guide local development setup
Browse files Browse the repository at this point in the history
  • Loading branch information
jar-b committed Sep 19, 2023
1 parent 9f111e1 commit 9aadc03
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions docs/README.md
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
```

0 comments on commit 9aadc03

Please sign in to comment.