From 36751a42f4f8630e6e6ca056389d44af1135c6de Mon Sep 17 00:00:00 2001 From: Rodrigue Koffi Date: Wed, 16 Aug 2023 12:39:37 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c43781..4ff9569 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ GitHub provides additional document on [forking a repository](https://help.githu ## 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 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