From e2839d5f629018d39889a6ca92aa340371643a1c Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Wed, 28 Apr 2021 23:45:07 +0200 Subject: [PATCH] Contribute to doc (#347) Co-authored-by: CrazyMax --- .github/CONTRIBUTING.md | 12 ++++++++++++ docs/contributing.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6ddcbd50..15b00555 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,6 +24,18 @@ Here are a few things you can do that will increase the likelihood of your pull * Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**. * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +## Documentation + +If you want to contribute to the documentation you can test its rendering locally with the following commands: + +```shell +# Build mkdocs image +docker build -t mkdocs -f ./hack/docs.Dockerfile --target base . +# Run mkdocs image and watch for changes +docker run --rm -it -p 8000:8000 -v $(pwd):/docs mkdocs +# Open http://localhost:8000 on your browser +``` + ## Resources * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) diff --git a/docs/contributing.md b/docs/contributing.md index f1f137d1..1e088ee7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -24,6 +24,18 @@ Here are a few things you can do that will increase the likelihood of your pull * Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**. * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +## Documentation + +If you want to contribute to the documentation you can test its rendering locally with the following commands: + +```shell +# Build mkdocs image +docker build -t mkdocs -f ./hack/docs.Dockerfile --target base . +# Run mkdocs image and watch for changes +docker run --rm -it -p 8000:8000 -v $(pwd):/docs mkdocs +# Open http://localhost:8000 on your browser +``` + ## Resources * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)