mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
Update contributing (#3339)
This commit is contained in:
parent
7cc05581d1
commit
f794d10bb5
|
@ -13,7 +13,9 @@ When refactoring, writing or altering scripts or other files, adhere to these ru
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
You will need to have Docker installed. Navigate into the `docs/` directory. Then run:
|
Make sure to select `edge` in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.
|
||||||
|
|
||||||
|
Alternatively you can make the changes locally. For that you'll need to have Docker installed. Navigate into the `docs/` directory. Then run:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material
|
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material
|
||||||
|
|
Loading…
Reference in a new issue