Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bonclay7 authored Aug 8, 2023
1 parent 26371d5 commit 9f90ec8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ GitHub provides additional document on [forking a repository](https://help.githu

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:

1. [Install](https://www.mkdocs.org/user-guide/installation/) 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
3. Create the corresponding file in [/docs](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/docs), matching the structure defined in `mkdocs.yml`
4. Render locally using `mkdocs serve`
Expand Down

0 comments on commit 9f90ec8

Please sign in to comment.