Commit graph

25 commits

Author SHA1 Message Date
wernerfred 1a8552b96c docs(refactor): Restructure document hierarchy
Additionally rename `installation-examples.md` and split
2021-03-25 11:49:24 +13: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
Mohammed Chotia c7eef0ab4c Fix small typo 2017-11-02 12:32:42 +02:00
Johan Smits 8d7d934267 Update wiki to change the fetchmail poll interval 2017-10-05 08:30:23 +02:00
Josef Friedrich 1276a7d95e Update name 2016-09-04 19:12:17 +02:00
Josef Friedrich b5ddfbd867 Add sample debug output 2016-08-30 00:14:21 +02:00
Josef Friedrich c47a50d971 Add ssl to samlpe configuration. SSL is always good 2016-08-30 00:10:48 +02:00
Josef Friedrich 51f59208b7 New Section: Polling interval 2016-08-29 22:13:22 +02:00
Josef Friedrich fadfa853a2 Use setup.sh for debugging 2016-08-29 22:04:40 +02:00
Josef Friedrich 3a6b6ef198 Use quotation marks for hostnames for better separation between key and values. Imap and pop3 can't be written in quotation marks. 2016-08-22 22:42:25 +02:00
Josef Friedrich 393b5239c5 Add "IMPORTANT" warning 2016-08-22 22:30:47 +02:00
Josef Friedrich ec1064de3b password should be pass 2016-08-22 22:24:07 +02:00
Josef Friedrich e963f7f65e Shorter examples 2016-08-22 22:23:34 +02:00
Josef Friedrich 41a9de317b Add link to chapter 2016-08-22 10:45:14 +02:00
Josef Friedrich 19d2fd6fec Fix links 2016-08-22 10:41:52 +02:00
Josef Friedrich 256291895f Add link to the fetchmail man page 2016-08-22 10:40:34 +02:00
Josef Friedrich 2fbca66b28 Updated Retrieve emails from a remote mail server (using builtin fetchmail) (markdown) 2016-08-22 10:25:14 +02:00
Josef Friedrich 8623b155a0 Add more headlines 2016-08-22 10:23:51 +02:00
Josef Friedrich 941114be12 Add link to fetchmail website 2016-08-22 10:20:59 +02:00
Josef Friedrich 4f46a059ce Add tree view of folder structure 2016-08-22 10:16:47 +02:00
Josef Friedrich 0e9ce32dcc Add debug commands 2016-08-22 10:12:04 +02:00
Josef Friedrich e354569eda Remove warning 2016-08-21 23:32:05 +02:00
Josef Friedrich e633624155 Add configuration examples 2016-08-21 14:10:33 +02:00
Josef Friedrich 45bc1a44d3 Better docker-compose example 2016-08-21 14:03:37 +02:00
Josef Friedrich 3b7ed57dde Add documentation proposal for fetchmail service 2016-08-21 14:02:06 +02:00