Commit Graph

174 Commits

Author SHA1 Message Date
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
Mike Hillyer ab54426232 Fixes to changelog version naming. 2023-03-12 00:34:19 -05:00
Wez Furlong 77b91cf3cc docs: adjust PATH for pip 2023-03-11 22:30:11 -07:00
Mike Hillyer 3620d07026 More formatting. 2023-03-12 00:25:27 -05:00
Mike Hillyer e0531e053a Add missing file. 2023-03-12 00:16:16 -05:00
Mike Hillyer 6b70bdcab0 Automated doc formatting fix 2023-03-12 05:13:33 +00:00
Mike Hillyer 928e3cdf2b Updating structure, adding index pages to each section, along with updating the documentation landing page. 2023-03-12 00:12:42 -05:00
Mike Hillyer 4b4391516d Rearranging the documentation for new Material for Mkdocs 2023-03-11 23:49:48 -05:00
Wez Furlong 8a1bf0b7a3 docs: cleanup toc structure a bit
Remove a redundant parent node to simplify things.
A couple of Page entries were just containers and
had no content of their own; you can now set the filename
to None to indicate that, and adjust what gets emitted
in the nav.
2023-03-11 20:52:21 -07:00
Wez Furlong a841b1e635 docs: do black formatting in docs/build.sh
This way it should get included in the automated fixup commit
performed by the workflow
2023-03-11 20:41:44 -07:00
Wez Furlong ade3ae5bac docs: remove some mdbook related files that are now unused 2023-03-11 20:37:40 -07:00
Wez Furlong f0c893582e switch from mdbook to mkdocs 2023-03-11 20:13:54 -07:00
Wez Furlong 269e0702b4 add SMTP AUTH PLAIN support
Verified via:

```
swaks ... --auth plain --tls --auth-user scott --auth-password tiger
```
2023-03-11 16:23:49 -07:00
Tom Mairs d28e024c6f Updates to System Prep doc 2023-03-11 15:59:40 -07:00
Cloud User 5864e828b5 updates to Lua pages 2023-03-11 22:37:59 +00:00
Tom Mairs fb08b3acab Clean up OS prep doc 2023-03-11 15:18:24 -07:00
Mike Hillyer 10a37587a1 Learning how tables work, this time for sure! 2023-03-11 10:28:18 -05:00
Mike Hillyer 4c3671fde0 Table header 2023-03-11 10:25:49 -05:00
Mike Hillyer 96dc97c36b Let's see if tables work! 2023-03-11 10:22:45 -05:00
Mike Hillyer 12802d9494 More spelling and grammar fixes. 2023-03-11 10:06:25 -05:00
Wez Furlong c90f6896b0 Automated doc formatting fix 2023-03-11 14:54:46 +00:00
Wez Furlong 64f95405b5 docs: test breaking again 2023-03-11 07:54:19 -07:00
Wez Furlong c208705940 Automated doc formatting fix 2023-03-11 14:52:59 +00:00
Wez Furlong a39826d368 docs: test breaking formatting again 2023-03-11 07:50:18 -07:00