Commit graph

31 commits

Author SHA1 Message Date
Brennan Kinney fb72f3ad52
ci(docs): Fail when build aborts from broken links (#2266)
Using `set -ex` will exit the script as soon as a non-zero exit code is returned, such as when the docker image fails building the docs due to `build --strict` catching broken links. This also removes the need for `|| exit` when changing directory.

This seems fine for a small script, but AFAIK an alternative fix is just adding `|| exit` to the end of the `docker run` command too? There appears to be advice [against adopting `-e` carelessly](http://mywiki.wooledge.org/BashFAQ/105), while others [encourage `-e`](http://redsymbol.net/articles/unofficial-bash-strict-mode/). I know that several maintainers here have preference towards `set -e` so I've kept the original PR solution.

Additionally:

- `-x` is used to improve command visibility when reviewing the workflow log output.
- `--name` isn't necessary, but was part of the original PR.
- I've chosen not to include `-o pipefail`, only because no pipes are used in this script.

* docs(fix): Fix broken links

* ci(docs): Added inline docs

Extra documentation context for maintainers to quickly grok what's going on.

* chore(docs): Minor typo fix by wernerfred

Added from their related PR by request.
2021-10-31 09:13:18 +13:00
Brennan Kinney a0ee472501
docs(chore): Normalize for consistency (#2206)
"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.
2021-09-23 11:29:37 +12:00
polarathene 021e942c4c docs(refactor): Large refactor + additions + fixes
Consistency pass, formatting cleanup and fixes, introduce admonitions, add front-matter.

---

docs: Add front-matter

---

docs: Fix and format links

- Some links were invalid (eg files moved or renamed)
- Some were valid but had invalid section headers (content removed or migrated)
- Some use `http://` instead of `https://` when the website supports a secure connection.
- Some already used the `[name][reference]` convention but often with a number that wasn't as useful for maintenance.
- All referenced docs needed URLs replaced. Opted for the `[name][reference]` approach to group them all clearly at the bottom of the doc, especially with the relative URLs and in some cases many duplicate entries.
- All `tomav` references from the original repo prior to switch to an organization have been corrected.
- Minor cosmetic changes to the `name` part of the URL, such as for referencing issues to be consistent.
- Some small changes to text body, usually due to duplicate URL reference that was unnecessary (open relay, youtous)
- Switched other links to use the `[name][reference]` format when there was a large group of URLs such as wikipedia or kubernetes. Github repos that reference projects related to `docker-mailserver` also got placed here so they're noticed better by maintainers. This also helped quite a bit with `mermaid` external links that are very long.
- There was a Github Wiki supported syntax in use `[[name | link]]` for `fetchmail` page that isn't compatible by default with MkDocs (needs a plugin), converted to `[name][reference]` instead since it's a relative link.

---

docs: Update commit link for LDAP override script

Logic moved to another file, keeping the permalink commit reference so it's unaffected by any changes in the file referenced in future.

---

docs: Heading corrections

Consistency pass. Helps with the Table of Contents (top-right UI) aka Document Outline.
docs: codefence cleanup

---

docs: misc cleanup

---

docs: Add Admonitions

Switches `<details>` usage for collapsible admonitions (`???`) while other text content is switched to the visually more distinct admoniton (`!!!` or `???+`) style.

This does affect editor syntax highlighting a bit and markdown linting as it's custom non-standard markdown syntax.
2021-03-25 11:49:24 +13:00
Georg Lauterbach a5a6096032 Updated Configure Aliases (markdown) 2021-02-08 12:11:47 +01:00
Georg Lauterbach b5c46127ae Updated Configure Accounts (markdown) 2021-02-08 12:09:38 +01:00
Georg Lauterbach 7e04232f76 Updated Configure Aliases (markdown) 2021-01-27 22:07:59 +01:00
Georg Lauterbach 4609759703 Updated Configure Accounts (markdown) 2021-01-27 22:07:42 +01:00
Amin Vakil 78af9f97a2 Change postfix-aliases.cf to postfix-virtual.cf & add setup.sh alias link 2020-06-21 10:01:01 +04:30
Jean-Denis Vauguet 47f1ffe65c Updated Configure Aliases (markdown) 2020-05-31 04:52:34 +02:00
Jean-Denis Vauguet e269f4f381 Updated Configure Accounts (markdown) 2020-05-31 04:36:25 +02:00
Jean-Denis Vauguet dade40d66c Updated Configure Accounts (markdown) 2020-05-31 04:36:09 +02:00
Jean-Denis Vauguet 322cd2c169 Updated Configure Accounts (markdown) 2020-05-31 04:32:43 +02:00
Jean-Denis Vauguet 472088cf48 Updated Configure Accounts (markdown) 2020-05-31 04:30:39 +02:00
Jean-Denis Vauguet aea271d6fe Updated Configure Accounts (markdown) 2020-05-29 05:37:48 +02:00
youtous 19a86565d7 Updated Configure Accounts (markdown) 2020-05-01 23:53:37 +02:00
youtous 478d073deb quota update 2020-05-01 23:53:23 +02:00
youtous ee7e314c39 Updated Configure Accounts (markdown) 2020-04-26 19:38:49 +02:00
youtous a8969647c6 quota update 2020-04-25 23:29:37 +02:00
Johan Smits caaae0eb76 Add note that a container restart is needed 2017-09-13 08:21:32 +02:00
Thomas VIAL 504494e4dd Updated Configure Accounts (markdown) 2017-06-19 20:39:22 +02:00
Thomas VIAL fc9f40b398 Added information regarding multi-domain 2017-06-19 20:38:37 +02:00
arneke 19355761c6 Expanded recipient delimiter description because the referenced blog post does not cover Dovecot LDA 2017-03-27 00:15:28 +02:00
Petar Šegina 656cf5f34c Mention address tags #542 2017-03-19 14:54:58 +01:00
柯十六夜 0d7cd4f775 Updated Configure Aliases (markdown) 2016-12-15 03:19:31 +08:00
Thomas VIAL b21282cea8 Updated Configure Accounts (markdown) 2016-06-14 18:07:42 +02:00
Thorsten von Eicken 3612f314de Associated with PR #194 2016-05-23 21:08:23 -07:00
Thomas VIAL 7c3902f86f Updated Configure Accounts (markdown) 2016-05-11 10:28:51 +02:00
Thomas VIAL 395acf5e27 Updated Configure Accounts (markdown) 2016-04-25 06:07:51 +02:00
Thomas VIAL e41eaed7d5 Updated Configure Accounts (markdown) 2016-04-25 06:06:15 +02:00
Thomas VIAL b92d3cb1b3 Created Configure Accounts (markdown) 2016-04-24 17:18:18 +02:00
Thomas VIAL 9bb13e7c3a Created Configure Aliases (markdown) 2016-04-24 17:17:17 +02:00