Skip to content

Commit

Permalink
docs: update contributor doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kylesomers committed Sep 27, 2024
1 parent 2eae3b7 commit 72e022d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<Semantic Release 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=<VERSION> ALIAS=<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=<VERSION> ALIAS=<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).
Expand Down

0 comments on commit 72e022d

Please sign in to comment.