mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
a0ee472501
"Brief" summary/overview of changes. See the PR discussion or individual commits from the PR for more details.
---
Only applies to the `docs/content/**` content (_and `setup` command_). `target/` and `test/` can be normalized at a later date.
* Normalize to `example.com`
- Domains normalized to `example.com`: `mywebserver.com`, `myserver.tld`, `domain.com`, `domain.tld`, `mydomain.net`, `my-domain.tld`, `my-domain.com`, `example.org`, `whoami.com`.
- Alternative domains normalized to `not-example.com`: `otherdomain.com`, `otherdomain.tld`, `domain2.tld`, `mybackupmx.com`, `whoareyou.org`.
- Email addresses normalized to `admin@example.com` (in `ssl.md`): `foo@bar.com`, `yourcurrentemail@gmail.com`, `email@email.com`, `admin@domain.tld`.
- Email addresses normalized to `external-account@gmail.com`: `bill@gates321boom.com`, `external@gmail.com`, `myemail@gmail.com`, `real-email-address@external-domain.com`.
- **`faq.md`:** A FAQ entry title with `sample.domain.com` changed to `subdomain.example.com`.
- **`mail-fetchmail.md`:** Config examples with FQDNs for `imap`/`pop3` used `example.com` domain for a third-party, changed to `gmail.com` as more familiar third-party/external MTA.
* Normalize config volume path
- Normalizing local config path references to `./docker-data/dms/config/`: `./config/`, `config/`, \``config`\`, `/etc/` (_volume mount src path prefix_).
- Normalize DMS volume paths to `docker-data/dms/mail-{data,state,log}`: `./mail`, `./mail-state` `./data/mail`, `./data/state`, `./data/logs`, `./data/maildata`, `./data/mailstate`, `./data/maillogs`, (_dropped/converted data volumes: `maildata`, `mailstate`_).
- Other docker images also adopt the `docker-data/{service name}/` prefix.
* `ssl.md` - Use `dms/custom-certs` where appropriate.
* Apply normalizations to README and example `docker-compose.yml`
---
Common terms, sometimes interchangeably used or now invalid depending on context: `mail`, `mail container`, `mail server`, `mail-server`, `mailserver`,`docker-mailserver`, `Docker Mailserver`.
Rough transformations applied to most matches (_conditionally, depending on context_):
- 'Docker Mailserver' => '`docker-mailserver`'
- 'mail container' => '`docker-mailserver`' (_optionally retaining ' container'_)
- 'mail server' => 'mail-server' / '`docker-mailserver`'
- 'mail-server' => '`docker-mailserver`'
- 'mailserver' => 'mail-server' / '`docker-mailserver`'
Additionally I checked `docker run` (_plus `exec`, `logs`, etc, sub-commands_) and `docker-compose` commands. Often finding usage of `mail` instead of the expected `mailserver`
Additionally changes `mailserver` hostname in k8s to `mail` to align with other non-k8s examples.
---
* drive-by revisions
Mostly minor revisions or improvements to docs that aren't related to normalization effort.
54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
---
|
|
title: 'Contributing | Documentation'
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
You will need have Python and Python pip installed. Or just docker.
|
|
|
|
## Building and serving the documentation
|
|
|
|
This tutorial was written using Python `2.7.18` and Python pip `20.3.4`.
|
|
And Docker `19.03.6`.
|
|
|
|
### Python way
|
|
|
|
#### Install the modules
|
|
|
|
The documentation builder
|
|
|
|
```sh
|
|
pip install mkdocs
|
|
```
|
|
|
|
Now the theme
|
|
|
|
```sh
|
|
pip install mkdocs-material
|
|
```
|
|
|
|
#### Serve
|
|
|
|
!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)"
|
|
|
|
```sh
|
|
mkdocs serve
|
|
```
|
|
|
|
Wait for it to build and open the URL in your browser.
|
|
Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.
|
|
|
|
### Docker way
|
|
|
|
Using the official image ([squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material)) for our documentation theme.
|
|
|
|
#### Serve
|
|
|
|
!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)"
|
|
|
|
```sh
|
|
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material
|
|
```
|
|
|
|
Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.
|