cf83f8ed7e
Add meta descriptions to the Userguide and Tutorial.
2026-07-09 18:07:40 -04:00
d878f95021
Minor mechanical fixes. Capitalization and punctuation mostly. Also testing defined meta descriptions.
2026-07-09 14:31:23 -04:00
164f109326
Traffic Shaping Refactor First Pass
2026-06-09 13:23:56 -04:00
b5fb4bd1f9
docs: replace manual http docs with generated docs
...
we now just have one section containing docs for the HTTP API,
which makes things a bit easier to reason about.
2026-02-02 08:17:20 +00:00
a1a5f71852
Update note about minimum supported instance
2025-08-08 14:47:18 +00:00
eddc42b45c
Add missing space in Markdown link to 'UserGuide'
2025-02-28 08:41:39 -08:00
2037371793
Fix a couple of minor linter issues before push.
2024-09-16 11:33:09 -04:00
22f3ea4454
Finish update of quickstart tutorial.
2024-09-16 11:30:49 -04:00
a643c07aaf
Initial updates to quickstart tutorial, fix for shaping.toml regex strings and added a note about suffixes to the traffic shaping documentation.
2024-09-16 11:18:21 -04:00
84cb629c91
docs: fix doc build after tsa page was removed
2024-09-09 06:46:59 -07:00
7961bff955
docs: split configure_local_logs into multiple pages
2024-08-18 22:28:41 -07:00
cf7f5843ab
Add a stronger warning that the quickstart does not produce production-ready installs.
2024-07-05 10:58:37 -04:00
c42536ee77
Updating the quickstart tutorial.
2024-07-05 09:48:20 -04:00
d416b31af9
docs: add toml_data macro
...
This macro allows embedding TOML data into the docs,
and showing it in a tab that has both the TOML and JSON
representation of that data.
It works by executing the toml2jsonc helper that was added
in an earlier commit.
There's some machinery here to compile that utility to run
in the context of the mkdocs docker image; that works
locally, let's see how well it works in CI!
Usage is simple; before:
```toml
["something"]
foo = "bar"
```
after:
{% call toml_data() %}
["something"]
foo = "bar"
{% endcall %}
The first page to get switched over to this is https://docs.kumomta.com/tutorial/configuring_kumomta/
refs: https://github.com/KumoCorp/kumomta/issues/212
2024-07-03 14:59:52 -07:00
53820402ba
Killing off some orphans.
2024-06-20 17:55:52 -04:00
88cdfce76f
Fix broken link in the config section of the Tutorial.
2024-06-11 17:26:17 -04:00
b24c67ff59
Update install tutorial to point to the User Guide for users not on Rocky.
2024-06-11 14:49:21 -04:00
8624da376a
Fixing what I thought was a problem, but the build isn't happening which was probably the issue in the first place.
2024-02-09 10:26:03 -05:00
cfd5687300
More attempts to fix ordering and indentation.
2024-02-09 10:06:43 -05:00
ab1c84c7e1
Trying to correct the restart of the step numbering.
2024-02-09 09:46:43 -05:00
07d13203c9
Add traffic shaping Youtube video embeds to the relevant pages.
2024-01-09 18:00:04 -05:00
45c0a190d2
Fix formatting of one of the notes on the config tutorial page.
2023-12-21 15:06:30 -05:00
998f6d5707
Add video link to example config video to tutorial page.
2023-12-21 14:52:29 -05:00
9ab48b8d13
Make the TSA config step in the config section of the tutorial more clear.
2023-12-19 18:02:28 -05:00
42d8a8cd03
Bring the configuration page of the tutorial in line with the latest example config.
2023-12-14 16:52:52 -05:00
eead8d568f
Split out the install/config/start sections of the tutorial.
2023-11-16 17:12:02 -05:00
d433bea3f1
Add troubleshooting page, add cross-reference from Tutorial, remove orphaned integration pages from Tutorial directory.
2023-10-19 22:22:33 -04:00
141beb60f6
Link fix.
2023-10-18 23:16:12 -04:00
32f8060ecc
docs: logging: flush after 10s, clarify in quickstart and tutorial
...
New users trip over the very conservative defaults on log flushing,
so let's make the `init.lua` that we populate for new installs
set the duration to 10 seconds by default, and adjust the language
in the docs to match that.
Clarify the logging documentation about how the logs are
chunked/flushed.
2023-10-12 21:27:39 -04:00
cc7d57ee16
Testing video embed
2023-10-04 17:19:14 -04:00
112cc7e307
More tweaks.
2023-09-28 17:40:35 -04:00
4b29d52f87
Clarify the condensed nature of the quickstart.
2023-09-28 17:38:12 -04:00
233966ab67
Add next steps heading to the tutorial, update hashicorp vault page to better match userguide tone.
2023-09-28 17:16:52 -04:00
03b0d12b56
Finish initial edits of tutorial, move hasicorp content to user guide policy section, merge performance content into performance page in userguide operations section, pull lua page and add to userguide general section. Pull how it works, redundant to config concepts in user guide.
2023-09-28 16:56:23 -04:00
26a253da45
Update examples to use bash instead of console, it looks prettier.
2023-09-28 15:57:55 -04:00
bffdec5ed1
Update the install, test, and logs pages of the tutorial.
2023-09-28 14:05:26 -04:00
0d6993bcf2
Update more of the tutorial for formatting, wording, and information.
2023-09-28 12:05:54 -04:00
50124576e3
Renaming the initial tutorial page.
2023-09-27 17:45:52 -04:00
6ddff4ee81
Updated day one tutorial page, also updated example config to make it clearer that supporting .toml files must be in place.
2023-09-27 17:37:20 -04:00
f8dd552ad7
fix typo
2023-09-25 16:25:20 +00:00
e523cc28ff
add tailer command to tutorial
2023-09-25 15:41:56 +00:00
df678eb13f
tutorial updates
2023-09-21 23:14:15 +00:00
aeddc9b5e1
remove new tab links
2023-09-21 22:14:44 +00:00
0b3a064544
testing new tab links
2023-09-21 21:43:06 +00:00
3087688800
Update link in tutorial.
2023-09-21 13:09:54 -04:00
3880623791
Update link to example config in Userguide.
2023-09-21 09:45:48 -04:00
519f508139
fix link
2023-08-21 17:14:03 +00:00
502ae37e44
fix curl sample
2023-08-21 16:43:58 +00:00
3ced8144b7
add flow description page
2023-08-04 20:47:13 +00:00
3beb79f9f4
fix typo
2023-08-04 20:26:17 +00:00
Mike Hillyer
Wez Furlong
Tom Mairs
Ryan Bonnell
Mike Hillyer
Tom Mairs