From 72e022d6715b3b36c32352180a7a454f98433953 Mon Sep 17 00:00:00 2001 From: Kyle Somers <17753062+kylesomers@users.noreply.github.com> Date: Fri, 27 Sep 2024 20:22:12 +0000 Subject: [PATCH] docs: update contributor doc --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79acd33c..2c41947c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,10 +54,13 @@ Looking at the existing issues is a great way to find something to contribute on This project uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to generate versioned documentation automatically. Content for the documentation is auto-generated by referencing the markdown contained in the project's `README.md` files. **Local development:** -- To build the project documentation, run: `make docs-local-docker VERSION=`. This will build the project using `./docs/Dockerfile` and host the documentation using `mkdocs serve` on port `8000`. + +* To build the project documentation, execute the following command: `make docs-local-docker VERSION= ALIAS=`, including a semantic release version (i.e. `v1.0.0`) and an alias (i.e. `latest`). This will build the project using `./docs/Dockerfile`. +* To run the documentation locally, execute the following command: `make docs-run VERSION= ALIAS=` which runs the documentation in a local container using `mkdocs serve` on port `8000`. **Live documentation (GitHub Pages):** -- A Github workflow is used to build and deploy the documentation to the gh-pages branch: `.github/workflows/docs.yml` + +* A Github workflow is used to build and deploy the documentation to the gh-pages branch: `.github/workflows/docs.yml` ## Code of Conduct This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).