mirror of
https://github.com/storytold/terraform-aws-observability-accelerator.git
synced 2026-10-09 00:09:43 +00:00
Update CONTRIBUTING.md
This commit is contained in:
+1
-1
@@ -44,7 +44,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
|
|||||||
|
|
||||||
## Documentation with mkdocs
|
## Documentation with mkdocs
|
||||||
|
|
||||||
Some features require documentation in our [GitHub pages site](https://aws-observability.github.io/terraform-aws-observability-accelerator/). We use [mkdocs](https://www.mkdocs.org/) which supports Markdown plus some [additional features](https://squidfunk.github.io/mkdocs-material/reference/). When working on your local copy you might want to check your changes before submitting. Here's a couple of steps to follow when adding documentation:
|
Some features require documentation in our [GitHub pages site](https://aws-observability.github.io/terraform-aws-observability-accelerator/). We use [mkdocs]([https://www.mkdocs.org/](https://squidfunk.github.io/mkdocs-material/)) which supports Markdown plus some [additional features](https://squidfunk.github.io/mkdocs-material/reference/). When working on your local copy you might want to check your changes before submitting. Here's a couple of steps to follow when adding documentation:
|
||||||
|
|
||||||
1. [Install](https://squidfunk.github.io/mkdocs-material/getting-started/) mkdocs
|
1. [Install](https://squidfunk.github.io/mkdocs-material/getting-started/) mkdocs
|
||||||
2. If you add a new page, define the page in the [mkdocs.yml](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/mkdocs.yml) file
|
2. If you add a new page, define the page in the [mkdocs.yml](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/mkdocs.yml) file
|
||||||
|
|||||||
Reference in New Issue
Block a user