Skip to content

Commit 36751a4

Browse files
authored
Update CONTRIBUTING.md
1 parent 0e4c224 commit 36751a4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
4444

4545
## Documentation with mkdocs
4646

47-
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:
47+
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:
4848

4949
1. [Install](https://squidfunk.github.io/mkdocs-material/getting-started/) mkdocs
5050
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

0 commit comments

Comments
 (0)