From 724fe72d2076a8dd326fa85daa0fb7df84306027 Mon Sep 17 00:00:00 2001 From: wernerfred <20406381+wernerfred@users.noreply.github.com> Date: Thu, 11 Mar 2021 20:41:24 +0100 Subject: [PATCH] docs: Update metadata and links to new locations Also removed the FAQ inline heading link for Rancher. It's not a relevant link (as the question already expects knowledge of Rancher), and breaks out of the bg colour heading style due to the HTML generation logic from mkdocs. --- docs/content/config/advanced/auth-ldap.md | 2 +- docs/content/config/advanced/full-text-search.md | 2 +- docs/content/config/advanced/ipv6.md | 2 +- docs/content/config/advanced/kubernetes.md | 2 +- docs/content/config/advanced/mail-fetchmail.md | 4 ++-- docs/content/config/advanced/mail-sieve.md | 2 +- docs/content/config/advanced/optional-config.md | 16 ++++++++-------- .../examples/tutorials/basic-installation.md | 2 +- .../tutorials/mailserver-behind-proxy.md | 6 +++++- docs/content/faq.md | 6 +++--- docs/content/index.md | 4 ++-- docs/mkdocs.yml | 2 +- 12 files changed, 27 insertions(+), 23 deletions(-) diff --git a/docs/content/config/advanced/auth-ldap.md b/docs/content/config/advanced/auth-ldap.md index 8e0f4eb7..e369d310 100644 --- a/docs/content/config/advanced/auth-ldap.md +++ b/docs/content/config/advanced/auth-ldap.md @@ -1,5 +1,5 @@ --- -title: 'LDAP Authentication' +title: 'Advanced | LDAP Authentication' --- ## Introduction diff --git a/docs/content/config/advanced/full-text-search.md b/docs/content/config/advanced/full-text-search.md index 2a73507c..29a88d58 100644 --- a/docs/content/config/advanced/full-text-search.md +++ b/docs/content/config/advanced/full-text-search.md @@ -1,5 +1,5 @@ --- -title: 'Full-Text Search' +title: 'Advanced | Full-Text Search' --- ## Overview diff --git a/docs/content/config/advanced/ipv6.md b/docs/content/config/advanced/ipv6.md index c5ec5fb1..56c02ee4 100644 --- a/docs/content/config/advanced/ipv6.md +++ b/docs/content/config/advanced/ipv6.md @@ -1,5 +1,5 @@ --- -title: 'IPv6' +title: 'Advanced | IPv6' --- ## Background diff --git a/docs/content/config/advanced/kubernetes.md b/docs/content/config/advanced/kubernetes.md index 74a3bc31..bf4d90cd 100644 --- a/docs/content/config/advanced/kubernetes.md +++ b/docs/content/config/advanced/kubernetes.md @@ -1,5 +1,5 @@ --- -title: 'Kubernetes' +title: 'Advanced | Kubernetes' --- ## Deployment Example diff --git a/docs/content/config/advanced/mail-fetchmail.md b/docs/content/config/advanced/mail-fetchmail.md index 30aa6208..7713db52 100644 --- a/docs/content/config/advanced/mail-fetchmail.md +++ b/docs/content/config/advanced/mail-fetchmail.md @@ -1,5 +1,5 @@ --- -title: 'Email Gathering with Fetchmail' +title: 'Advanced | Email Gathering with Fetchmail' --- To enable the [fetchmail][fetchmail-website] service to retrieve e-mails set the environment variable `ENABLE_FETCHMAIL` to `1`. Your `docker-compose.yml` file should look like following snippet: @@ -114,7 +114,7 @@ fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 2 fetchmail: normal termination, status 1 ``` -[docs-setup]: ../config/setup.sh.md +[docs-setup]: ../../config/setup.sh.md [fetchmail-website]: https://www.fetchmail.info [fetchmail-docs]: https://www.fetchmail.info/fetchmail-man.html [fetchmail-docs-run]: https://www.fetchmail.info/fetchmail-man.html#31 diff --git a/docs/content/config/advanced/mail-sieve.md b/docs/content/config/advanced/mail-sieve.md index 001648f0..db6e779b 100644 --- a/docs/content/config/advanced/mail-sieve.md +++ b/docs/content/config/advanced/mail-sieve.md @@ -1,5 +1,5 @@ --- -title: 'Email Filtering with Sieve' +title: 'Advanced | Email Filtering with Sieve' --- ## User-Defined Sieve Filters diff --git a/docs/content/config/advanced/optional-config.md b/docs/content/config/advanced/optional-config.md index 97702c0b..3d8dc57b 100644 --- a/docs/content/config/advanced/optional-config.md +++ b/docs/content/config/advanced/optional-config.md @@ -1,5 +1,5 @@ --- -title: 'Optional Configuration' +title: 'Advanced | Optional Configuration' hide: - toc # Hide Table of Contents for this page --- @@ -39,16 +39,16 @@ This is a list of all configuration files and directories which are optional or - **dovecot.cf:** replaces `/etc/dovecot/local.conf`. (Docs: [Override Dovecot Defaults][docs-override-dovecot]) - **dovecot-quotas.cf:** list of custom quotas per mailbox. (Docs: [Accounts][docs-accounts-quota]) -[docs-accounts-quota]: ../config/user-management/accounts.md#notes -[docs-aliases-regex]: ../config/user-management/aliases.md#configuring-regexp-aliases -[docs-dkim]: ../config/best-practices/dkim.md -[docs-fail2ban]: ../config/security/fail2ban.md -[docs-faq-spamrules]: ../config/troubleshooting/faq.md#how-can-i-manage-my-custom-spamassassin-rules +[docs-accounts-quota]: ../../config/user-management/accounts.md#notes +[docs-aliases-regex]: ../../config/user-management/aliases.md#configuring-regexp-aliases +[docs-dkim]: ../../config/best-practices/dkim.md +[docs-fail2ban]: ../../config/security/fail2ban.md +[docs-faq-spamrules]: ../../faq.md#how-can-i-manage-my-custom-spamassassin-rules [docs-override-postfix]: ./override-defaults/postfix.md [docs-override-dovecot]: ./override-defaults/dovecot.md [docs-relayhosts-senderauth]: ./mail-forwarding/relay-hosts.md#sender-dependent-authentication [docs-relayhosts-senderhost]: ./mail-forwarding/relay-hosts.md#sender-dependent-relay-host [docs-sieve]: ./mail-sieve.md -[docs-setupsh]: ../config/setup.sh.md -[docs-ssl]: ../config/security/ssl.md +[docs-setupsh]: ../../config/setup.sh.md +[docs-ssl]: ../../config/security/ssl.md [github-commit-setup-stack.sh-L411]: https://github.com/docker-mailserver/docker-mailserver/blob/941e7acdaebe271eaf3d296b36d4d81df4c54b90/target/scripts/startup/setup-stack.sh#L411 diff --git a/docs/content/examples/tutorials/basic-installation.md b/docs/content/examples/tutorials/basic-installation.md index 3e89b558..7b63fab0 100644 --- a/docs/content/examples/tutorials/basic-installation.md +++ b/docs/content/examples/tutorials/basic-installation.md @@ -1,5 +1,5 @@ --- -title: 'Tutorials | Installation Examples' +title: 'Tutorials | Basic Installation' --- ## Building a Simple Mailserver diff --git a/docs/content/examples/tutorials/mailserver-behind-proxy.md b/docs/content/examples/tutorials/mailserver-behind-proxy.md index 1154ed1e..febccbf7 100644 --- a/docs/content/examples/tutorials/mailserver-behind-proxy.md +++ b/docs/content/examples/tutorials/mailserver-behind-proxy.md @@ -1,3 +1,7 @@ +--- +title: 'Tutorials | Mailserver behind Proxy' +--- + ## Using `docker-mailserver` behind a Proxy ### Information @@ -120,4 +124,4 @@ service imap-login { !!! note Port `10993` is used here to avoid conflicts with internal systems like `postscreen` and `amavis` as they will exchange messages on the default port and obviously have a different origin then compared to the proxy. -[docs-optionalconfig]: ../advanced/optional-config.md +[docs-optionalconfig]: ../../config/advanced/optional-config.md diff --git a/docs/content/faq.md b/docs/content/faq.md index f262f7a6..e142bbe4 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -1,5 +1,5 @@ --- -title: 'Troubleshooting | FAQ' +title: 'FAQ' --- ### What kind of database are you using? @@ -307,7 +307,7 @@ Otherwise, it could work with 512M of RAM. Current figure is about 850M and growing. If you get errors about clamav or amavis failing to allocate memory you need more RAM or more swap and of course docker must be allowed to use swap (not always the case). If you can't use swap at all you may need 3G RAM. -### Can `docker-mailserver` run in a [Rancher Environment](http://rancher.com/rancher/)? +### Can `docker-mailserver` run in a Rancher Environment? Yes, by adding the environment variable `PERMIT_DOCKER: network`. @@ -401,7 +401,7 @@ sed -i 's/rimap -r/rimap/' /etc/supervisor/conf.d/saslauth.conf supervisorctl update ``` -[docs-maintenance]: ../../advanced/maintenance/update-and-cleanup.md +[docs-maintenance]: ./config/advanced/maintenance/update-and-cleanup.md [github-issue-95]: https://github.com/docker-mailserver/docker-mailserver/issues/95 [github-issue-97]: https://github.com/docker-mailserver/docker-mailserver/issues/97 [github-issue-1247]: https://github.com/docker-mailserver/docker-mailserver/issues/1247 diff --git a/docs/content/index.md b/docs/content/index.md index c683a61a..14485769 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -23,8 +23,8 @@ This wiki provides you with advanced configuration, detailed examples, and hints We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the [Contributing section][docs-contributing]. [docs-contributing]: ./contributing/issues-and-pull-requests.md -[docs-faq]: ./config/troubleshooting/faq.md -[docs-optionalconfig]: ./advanced/optional-config.md +[docs-faq]: ./faq.md +[docs-optionalconfig]: ./config/advanced/optional-config.md [docs-setupsh]: ./config/setup.sh.md [github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md [github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index baf62d3b..49f10003 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -101,7 +101,7 @@ nav: - 'Mailserver behind Proxy': examples/tutorials/mailserver-behind-proxy.md - 'Use Cases': - 'Forward-Only Mailserver with LDAP': examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md - - 'FAQ' : faq/faq.md + - 'FAQ' : faq.md - 'Contributing': - 'Issues and Pull Requests': contributing/issues-and-pull-requests.md - 'Coding Style': contributing/coding-style.md