Mike Hillyer
d744d09f04
Skeleton out the Operation section of the User Guide.
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
Mike Hillyer
ab74c8b9c3
Automated doc formatting fix
2023-03-13 16:33:09 +00: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
381e65f777
remove special_for_centos7 page; roll info into getting started
2023-03-13 07:18:15 -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
f7e34f4d2b
docs: remove empty tutorial index page
...
Instead, the nav now goes straight to Getting Started
2023-03-13 06:25:23 -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
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
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
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
f0c893582e
switch from mdbook to mkdocs
2023-03-11 20:13:54 -07:00
Cloud User
5864e828b5
updates to Lua pages
2023-03-11 22:37:59 +00:00
Wez Furlong
7dcf953ccb
fix doc build
2023-03-10 06:15:38 -07:00
Tom Mairs
dad4083170
Adding OS Prep guides
2023-03-10 00:29:41 -07:00
Mike Hillyer
088ae10d58
Fix a bad path reference in the build script for the docs.
2023-03-09 13:34:43 -05:00
Cloud User
3632889cdf
Guide updates for CentOS7
2023-03-09 16:47:25 +00:00
Wez Furlong
772e1e1b89
format
2023-03-08 17:37:54 -07:00
Mike Hillyer
783a193538
First pass at the bug reporting page
2023-03-08 18:09:26 -05:00
Mike Hillyer
dcc2ad6f6c
Adding the overview section, fleshing out the preface.
2023-03-08 16:40:14 -05:00
Wez Furlong
258d9f8f64
docs: add a bit of an explanation about queueing
2023-03-07 08:27:44 -07:00
Wez Furlong
a05724e40c
auto-format generate-toc.py too
2023-03-07 07:36:50 -07:00
Tom Mairs
8186354766
fix relative links in files
2023-03-07 00:23:04 +00:00
Tom Mairs
295a33dce3
bulk updated to user guide
2023-03-07 00:11:12 +00:00
Wez Furlong
eaaddbb6b6
add redis client
2023-03-05 09:57:03 -07:00
Wez Furlong
2cf3d2387c
add sqlite data access
...
A bit of a big commit because I wanted sqlite queries to run
async and there isn't a sane way to tell in mlua whether a
given context is safe to yield for an await, which meant making
every case where we call into lua be fully async.
This adds a simple but powerful binding to sqlite that performs
its IO in a blocking tokio thread pool, and returns the results
back to lua.
There is no implicit caching of queries, and no implicit connection
pooling.
2023-03-04 18:07:31 -07:00
Tom Mairs
2480991dcf
clean up sub pages
2023-03-01 08:08:09 +00:00
Tom Mairs
2699111362
fixed page order in guide
2023-03-01 07:45:09 +00:00
Mike Hillyer
e94b8e5a08
Fix typos, remove southern accent.
2023-02-27 12:32:17 -05:00
Mike Hillyer
94c4100c03
Change Docs Structure
2023-02-27 12:27:58 -05:00
Wez Furlong
6645763606
docs: document HTTP APIs
2023-02-25 22:42:08 -07:00
Wez Furlong
51d9928ead
docs: add more reference content
2023-02-25 20:41:50 -07:00
Wez Furlong
bfe1d5f94b
docs: add some basic reference info
...
The content here needs to be fleshed out some more, but this commit
is intended to get the skeleton in place.
2023-02-25 14:59:20 -07:00
Mike Hillyer
a147033987
Introduce initial skeleton content to the docs.
2023-02-25 14:05:50 -05:00
Wez Furlong
831bfe9aab
docs: skeleton for building the docs
...
Rather than edit SUMMARY.md, you edit docs/generate-toc.py
and it will flesh out sections based on the list of files
in a directory.
2023-02-25 10:50:58 -07:00
Mike Hillyer
Wez Furlong
Tom Mairs
almalinux Cloud User
Cloud User
Cloud User