Add documentation index page

moisseev · Apr 28, 2024 · 661841c · 661841c
1 parent edb7ba8
commit 661841c
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 32 deletions.
diff --git a/_layouts/doc.html b/_layouts/doc.html
@@ -70,7 +70,7 @@
 	<div class="r-docs-nav px-4">
 		<ul class="list-group list-group-flush">
 			<li class="r-docs-subnav list-group-item">
-				<a href="{{ site.baseurl }}/doc/index.html">About Rspamd</a>
+				<a href="{{ site.baseurl }}/doc/about/index.html">About Rspamd</a>
 				<ul>
 					<li><a href="{{ site.baseurl }}/downloads.html">Downloads</a></li>
 					<li><a href="{{ site.baseurl }}/features.html">Features</a></li>

diff --git a/doc/about/index.md b/doc/about/index.md
@@ -0,0 +1,36 @@
+---
+layout: doc
+title: About Rspamd
+---
+# About Rspamd
+
+## Introduction
+
+**Rspamd** is an advanced spam filtering system that allows evaluation of messages by a number of
+rules including regular expressions, statistical analysis and custom services
+such as URL black lists. Each message is analysed by Rspamd and given a `spam score`.
+
+According to this spam score and the user's settings, Rspamd recommends an action for
+the MTA to apply to the message, for example, to pass, reject or add a header.
+Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of
+useful features.
+
+## Getting Started
+
+A good starting point to study how to install and configure Rspamd is [the quick start guide]({{ site.baseurl }}/doc/tutorials/quickstart.html).
+
+Rspamd is [packaged]({{ site.baseurl }}/downloads.html) for the major Linux distributions, and is also available via [FreeBSD ports](https://freshports.org/mail/rspamd){:target="&#95;blank"}, NetBSD [pkgsrc](https://pkgsrc.org){:target="&#95;blank"} and [OpenBSD ports](https://openports.pl/path/mail/rspamd){:target="&#95;blank"}.
+
+You can also watch some [videos about Rspamd]({{ site.baseurl }}/media.html).
+
+## Spam filtering features
+
+Rspamd is shipped with various spam filtering modules and features enabled just out of the box.
+The full list of built-in modules could be found in the [modules documentation]({{ site.baseurl }}/doc/modules/).
+
+If that is not enough, Rspamd provides an extensive [Lua API]({{ site.baseurl }}/doc/lua/) to [write your own rules and plugins]({{ site.baseurl }}/doc/developers/writing_rules.html).
+
+
+## License
+
+This project is licensed under the [Apache 2.0 License](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)){:target="&#95;blank"}
diff --git a/doc/index.md b/doc/index.md
@@ -2,34 +2,18 @@
 layout: doc
 title: Documentation
 ---
-
-## Introduction
-
-**Rspamd** is an advanced spam filtering system that allows evaluation of messages by a number of
-rules including regular expressions, statistical analysis and custom services
-such as URL black lists. Each message is analysed by Rspamd and given a `spam score`.
-
-According to this spam score and the user's settings, Rspamd recommends an action for
-the MTA to apply to the message, for example, to pass, reject or add a header.
-Rspamd is designed to process hundreds of messages per second simultaneously, and provides a number of
-useful features.
-
-## Getting Started
-
-A good starting point to study how to install and configure Rspamd is [the quick start guide]({{ site.baseurl }}/doc/tutorials/quickstart.html).
-
-Rspamd is [packaged]({{ site.baseurl }}/downloads.html) for the major Linux distributions, and is also available via [FreeBSD ports](https://freshports.org/mail/rspamd){:target="&#95;blank"}, NetBSD [pkgsrc](https://pkgsrc.org){:target="&#95;blank"} and [OpenBSD ports](https://openports.pl/path/mail/rspamd){:target="&#95;blank"}.
-
-You can also watch some [videos about Rspamd]({{ site.baseurl }}/media.html).
-
-## Spam filtering features
-
-Rspamd is shipped with various spam filtering modules and features enabled just out of the box.
-The full list of built-in modules could be found in the [modules documentation]({{ site.baseurl }}/doc/modules/).
-
-If that is not enough, Rspamd provides an extensive [Lua API]({{ site.baseurl }}/doc/lua/) to [write your own rules and plugins]({{ site.baseurl }}/doc/developers/writing_rules.html).
-
-
-## License
-
-This project is licensed under the [Apache 2.0 License](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)){:target="&#95;blank"}
+# Documentation index
+
+|---|---|
+{% assign index_pages = site.pages | where: "name", "index.md" -%}
+{%- for pg in index_pages -%}
+    {%- assign path = pg.dir | split: "/" -%}
+    {%- comment -%}
+    # Split returns [] for "/" but ["", "doc"] "/doc/" as removes trailing empty strings.
+    # Skip page unless it is a sub-directory of "/doc/".
+    {%- endcomment -%}
+    {%- unless path[1] == "doc" and path.size == 3 -%}
+        {%- continue -%}
+    {%- endunless -%}
+|[{{ pg.title }}]({{ site.baseurl }}{{ pg.url }})|{{ pg.description }}|
+{% endfor -%}
diff --git a/doc/lua/index.md b/doc/lua/index.md
@@ -1,6 +1,7 @@
 ---
 layout: doc
 title: Lua API documentation
+description: Rspamd API for Lua rules and plugins.
 ---
 
 # Lua API documentation {#top}

diff --git a/doc/tutorials/index.md b/doc/tutorials/index.md
@@ -1,6 +1,7 @@
 ---
 layout: doc
 title: Tutorials and Guides
+description: Detailed guides on a variety of topics.
 ---
 # Tutorials and Guides
 

diff --git a/doc/workers/index.md b/doc/workers/index.md
@@ -1,6 +1,7 @@
 ---
 layout: doc
 title: Workers documentation
+description: Rspamd worker processes.
 ---
 # Rspamd workers