From 928e3cdf2beb6813b097716443b2efcd07ffa08a Mon Sep 17 00:00:00 2001 From: Mike Hillyer Date: Sun, 12 Mar 2023 00:12:42 -0500 Subject: [PATCH] Updating structure, adding index pages to each section, along with updating the documentation landing page. --- docs/changelog.md | 1 - docs/changelog/index.md | 3 +++ docs/generate-toc.py | 11 ++++++++--- docs/index.md | 9 ++++++++- docs/tutorial/index.md | 1 + docs/userguide/index.md | 1 + 6 files changed, 21 insertions(+), 5 deletions(-) delete mode 100644 docs/changelog.md create mode 100644 docs/changelog/index.md create mode 100644 docs/tutorial/index.md create mode 100644 docs/userguide/index.md diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index 93eb5e04..00000000 --- a/docs/changelog.md +++ /dev/null @@ -1 +0,0 @@ -# ChangeLog diff --git a/docs/changelog/index.md b/docs/changelog/index.md new file mode 100644 index 00000000..93a0af71 --- /dev/null +++ b/docs/changelog/index.md @@ -0,0 +1,3 @@ +# Changelog + +This is the KumoMTA changelog. Each release is in its own section, navigate to the desired section for the latest changes and updates to KumoMTA. diff --git a/docs/generate-toc.py b/docs/generate-toc.py index 21d52965..8dc69256 100755 --- a/docs/generate-toc.py +++ b/docs/generate-toc.py @@ -79,7 +79,7 @@ class Gen(object): TOC = [ Page( "Tutorial", - None, + "tutorial/index.md", children=[ Page("Getting Started", "tutorial/getting_started.md"), Page( @@ -120,7 +120,7 @@ TOC = [ ), Page( "User Guide", - None, + "userguide/index.md", children=[ Page("Preface and Legal Notices", "userguide/preface/index.md"), Page("About This Manual", "userguide/general/about.md"), @@ -166,7 +166,12 @@ TOC = [ Gen("HTTP API", "reference/http", extract_title=True), ], ), - Page("Change Log", "changelog.md"), + Page( + "Changelog", "changelog/index.md", + children=[ + Page("Release 2023-03-27 - Beta 1", "changelog/2023-03-27.md"), + ] + ), ] mode = sys.argv[1] diff --git a/docs/index.md b/docs/index.md index 07818bf5..1eaeb149 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,10 @@ -# KumoMTA +# KumoMTA Documentation +This the is documentation site for the KumoMTA Message Transfer Agent. +The documentation is organized into four sections: + +- The [Tutorial](/tutorial) - a beginner's guide for those who are new to setting up, configuring, testing, and deploying email infrastructure. +- The [User Guide](/userguide) - a guide for those who are familiar with email infrastructure but are new to KumoMTA and its unique features and capabilities. +- The [Reference Manual](/reference) - for those who are familiar with KumoMTA, and need to quickly look up syntax and examples for functions and modules. +- The [Changelog](/changelog) - a collection of all the updates, bug fixes, and changes made to KumoMTA on a per-release basis. diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md new file mode 100644 index 00000000..4f50eccc --- /dev/null +++ b/docs/tutorial/index.md @@ -0,0 +1 @@ +# Tutorial diff --git a/docs/userguide/index.md b/docs/userguide/index.md new file mode 100644 index 00000000..14e727f7 --- /dev/null +++ b/docs/userguide/index.md @@ -0,0 +1 @@ +# User Guide \ No newline at end of file