Back to Terraform Provider Aws

Documentation

docs/README.md

6.43.01.0 KB
Original Source
<!-- Copyright IBM Corp. 2014, 2026 --> <!-- SPDX-License-Identifier: MPL-2.0 -->

Documentation

This directory contains documentation for the Terraform AWS Provider Contributor Guide. Resource and data source documentation is located in the website directory and available in the Terraform Registry.

Local Development

To serve the contributing guide locally, mkdocs and the mkdocs-material extension must be installed. Both require Python and pip.

If using Homebrew, install both with

console
% brew install mkdocs-material

Otherwise, install directly using pip3

console
% pip3 install mkdocs
console
% pip3 install mkdocs-material

Once installed, the documentation can be served from the root directory:

console
% mkdocs serve --live-reload