Commit Graph

197 Commits

Author SHA1 Message Date
Mike Hillyer 331a46d8db Automated doc formatting fix 2023-03-14 20:09:36 +00:00
Mike Hillyer deab6adb40 Change toml file path to new /opt/kumomta/etc path style. 2023-03-14 16:08:42 -04:00
Mike Hillyer a074e9ec02 Automated doc formatting fix 2023-03-14 20:01:13 +00:00
Mike Hillyer 475b661712 Fixing Lua parse error in example policy. 2023-03-14 16:00:28 -04:00
Mike Hillyer fe9d51f289 Adding Wez's example of dynamic DKIM key path signing across both ingress routes (SMTP/API). 2023-03-14 15:56:39 -04:00
Mike Hillyer 5980d42375 Working on the example policy. 2023-03-14 15:31:02 -04:00
Wez Furlong a3d4c49ef1 docs: avoid copying $ prefixes from console code blocks
Rather than using `bash` for the mix of shell and output,
use `console`. That will cause the text to be marked up so
that the `$` prompt stuff won't get selected by dragging.

Enable copy button to copy the whole block, and add some
js to filter out the the $ and # prefixes from that content.
2023-03-14 10:17:55 -07:00
Wez Furlong 4c71090669 docs: standardize the header before the generated list of functions 2023-03-14 10:17:55 -07:00
Mike Hillyer 778025a876 Making sure the simple_policy.lua imports properly into the docs and renders. I'll modify it from there into the example policy. 2023-03-14 12:29:52 -04:00
Tom Mairs f5b4e6a701 Updates for Debian 11 and Rocky 9 2023-03-14 16:13:00 +00:00
Cloud User 00fd8c3c96 Updates for Debian 11 and Rocky 9 2023-03-14 15:50:46 +00:00
Mike Hillyer 1a2ef03502 Automated doc formatting fix 2023-03-14 14:22:44 +00:00
Mike Hillyer c84fa62f16 Adding skeleton for bounce config 2023-03-14 10:21:26 -04:00
Mike Hillyer 98eeb1f3e1 Adding more to the skeleton. 2023-03-14 09:52:46 -04:00
Wez Furlong 2e00292771 simply deb install very slightly 2023-03-13 23:47:29 -07:00
Wez Furlong ad978adddc simplify rpm repo install info 2023-03-13 23:23:19 -07:00
Wez Furlong 4ede25329c docs: use public URLs for repo definitions
add ubuntu sources.list files to the git repo, and publish to openrepo.

Now all our binary install instructions should work without requiring a github login while the repo is still private.
2023-03-13 23:02:02 -07:00
Wez Furlong cad1ad5c4d docs: show how to pull our image from the GH registry 2023-03-13 19:42:55 -07:00
Wez Furlong 6b9b01eca0 disable social media cards in local builds
Enable it for the final deploy
2023-03-13 15:38:18 -07:00
Wez Furlong 489ddec610 docs: simplify apt repo local filenames 2023-03-13 15:31:48 -07:00
Wez Furlong 950b2c4007 docs: add ubuntu install info 2023-03-13 15:28:52 -07:00
Mike Hillyer c6492e52cc Automated doc formatting fix 2023-03-13 19:52:30 +00:00
Mike Hillyer d744d09f04 Skeleton out the Operation section of the User Guide. 2023-03-13 15:51:38 -04:00
Mike Hillyer 7890f69cf7 Got rid of mis-spelled placeholder. 2023-03-13 15:51:38 -04:00
Wez Furlong 3a1b1053bd docs: add link checking
Ideally there would be a good mkdocs based checker, but the
one that is out there only validate absolute URLs, which makes
it unsuitable for checking local relative links in the docs.

Adjust the doc build so that we also generate the SUMMARY.md
for mdbook, and use mdbook's link checker to check the links.

Fixup the couple of broken links that it found.
2023-03-13 12:01:07 -07:00
Wez Furlong 89c0ea1331 docs: fix link for building from source 2023-03-13 11:12:15 -07:00
Mike Hillyer ab74c8b9c3 Automated doc formatting fix 2023-03-13 16:33:09 +00:00
Mike Hillyer 1457b7217d Cleanup of the bug reporting page. 2023-03-13 12:32:13 -04:00
Mike Hillyer b875641297 Adding configuration chapter skeleton. 2023-03-13 12:32:13 -04:00
Mike Hillyer 925c12c445 Automated doc formatting fix 2023-03-13 15:35:17 +00:00
Mike Hillyer ecd69baf42 Building out new UserGuide structure. 2023-03-13 11:34:23 -04:00
Wez Furlong dc47e50ec6 docs: tweak credits page 2023-03-13 07:45:57 -07:00
Wez Furlong 0d74b985ab docs: restore my edits for curling the injection api 2023-03-13 07:38:31 -07:00
Wez Furlong 1e1dbdb982 docs: update docker build instructions 2023-03-13 07:31:52 -07:00
Wez Furlong 381e65f777 remove special_for_centos7 page; roll info into getting started 2023-03-13 07:18:15 -07:00
Wez Furlong fe512c75a8 docs: from source: revise wording 2023-03-13 07:11:08 -07:00
Wez Furlong 7dc4728f5f docs: revise building from source instructions
Put most of the verbose bits into a get-deps.sh script
and have them run that.
2023-03-13 07:09:22 -07:00
Wez Furlong c41b8fa693 docs: make a pass over environment considerations 2023-03-13 06:33:56 -07:00
Wez Furlong f7e34f4d2b docs: remove empty tutorial index page
Instead, the nav now goes straight to Getting Started
2023-03-13 06:25:23 -07:00
Wez Furlong aef4c27bbc docs: use content tabs for docker install 2023-03-13 06:20:39 -07:00
Wez Furlong d14b39d86f docs: add centos7 rpm install to getting started
This uses the content tabs feature to group instructions by OS
2023-03-13 06:07:04 -07:00
Tom Mairs 2a3df1f2ba refining tutorial flow 2023-03-13 06:43:32 +00:00
almalinux Cloud User e9c926fee5 restructure Tutorial 2023-03-13 05:37:05 +00:00
Wez Furlong 0ab9b2870e docs: revise copyright notice
Until we confirm the name of the legal entity, just use me for the
moment.
2023-03-11 23:47:15 -07:00
Wez Furlong 52d204984a docs: install exclude plugin to exlude stuff better
Previously, I was cleaning up some junk like _index directories
generated from the _index.md fragments. I noticed that those
were showing up in the search index, so it is better to exclude
from the outset. mkdocs doesn't natively support the idea of
exclusion, but there is a plugin that does, so use it.
2023-03-11 23:27:49 -07:00
Wez Furlong b56bed5060 docs: fix admonish syntax, explain the global variable thing better 2023-03-11 23:06:59 -07:00
Wez Furlong a4d321cd82 docs: generate the changelog section
Add reverse sort so that we always show the latest at the top
2023-03-11 22:46:07 -07:00
Mike Hillyer 5823854f55 Changelog index grammar edit. 2023-03-12 00:39:53 -05:00
Mike Hillyer 38e766ab6e Rewrite filename scheme to match version scheme. 2023-03-12 00:38:07 -05:00
Mike Hillyer 38e9be00b0 Fixes. 2023-03-12 00:34:19 -05:00