Commit graph

8 commits

Author SHA1 Message Date
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
Frederic Werner 1e1059349d Updated Installation Examples (markdown) 2021-01-24 18:20:34 +01:00
Frederic Werner b5dc7ed8c1 Add section to use mailserver with proxy protocol 2021-01-24 17:09:12 +01:00
Georg Lauterbach 68e27162f3 added warning message for PERMIT_DOCKER=network when using IPv6 (#1405) 2020-09-27 22:15:21 +02:00
marios88 2a43e3c47e Updated Installation Examples (markdown) 2019-05-15 14:44:01 +03:00
Karthik K a4da228030 typo 2018-10-10 11:57:53 +05:30
Johan Smits fb17b3e81f Import the url with relevant items only 2018-07-10 18:51:55 +02:00
Dashamir Hoxha 71fd2bb05e Created Installation Examples (markdown) 2018-07-05 19:14:47 +02:00