Generate Tutorials documentation section

rspamd · Apr 26, 2024 · 913d510 · 913d510
1 parent c92cf07
commit 913d510
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 24 deletions.
diff --git a/_layouts/doc.html b/_layouts/doc.html
@@ -80,18 +80,7 @@
 				</ul>
 			</li>
 
-			<li class="r-docs-subnav list-group-item">
-				<a href="#">Tutorials and Guides</a>
-				<ul>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/quickstart.html">Quick start</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/integration.html">MTA integration</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/migration.html">Upgrading</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/fuzzy_storage.html">Own fuzzy storage</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/redis_replication.html">Replication in Redis</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/scanning_outbound.html">How to scan outbound emails</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/stunnel_setup.html">Setup stunnel to protect Redis</a></li>
-				</ul>
-			</li>
+			{% include directory-tree.html dir="/doc/tutorials" %}
 
 			<li class="r-docs-subnav list-group-item">
 				<a href="{{ site.baseurl }}/doc/faq.html">FAQ</a>
@@ -155,8 +144,6 @@
 				<a href="#">Other topics</a>
 				<ul>
 					<li><a href="{{ site.baseurl }}/doc/gtube_patterns.html">GTUBE-like test patterns</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/site_contributing.html">Contributing to web-site</a></li>
-					<li><a href="{{ site.baseurl }}/doc/tutorials/feedback_from_users_with_IMAPSieve.html">Getting feedback from users with IMAPSieve</a></li>
 					<li><a href="{{ site.baseurl }}/doc/rspamadm.html">Rspamadm command</a></li>
 					<li><a href="{{ site.baseurl }}/doc/usage_policy.html">Rspamd fuzzy feed and DNSBL usage policies</a></li>
 				</ul>

diff --git a/doc/tutorials/index.md b/doc/tutorials/index.md
@@ -1,17 +1,17 @@
 ---
 layout: doc
-title: Rspamd Tutorials
+title: Tutorials and Guides
 ---
-# Rspamd tutorials
+# Tutorials and Guides
 
-In this section you can find the current step-by-step tutorials coverign various topics about rspamd.
+In this section you can find the current step-by-step tutorials covering various topics about Rspamd.
 
 * [Migrating from SA](migrate_sa.html) - the guide for those who wants to migrate an existing SpamAssassin system to Rspamd
-* [Writing rspamd rules]({{ site.baseurl }}/doc/developers/writing_rules.html) - how to extend rspamd by writing your own rules
+* [Writing Rspamd rules]({{ site.baseurl }}/doc/developers/writing_rules.html) - how to extend Rspamd by writing your own rules
 * [Creating your fuzzy storage]({{ site.baseurl }}/doc/tutorials/fuzzy_storage.html) - learn how to make your own fuzzy storage
 * [Contributing to rspamd.com web-site](site_contributing.html) describes general conventions and how to test web-site changes
 * [Getting feedback from users with IMAPSieve](feedback_from_users_with_IMAPSieve.html) - how to get a copy of the message moved by user from or into the `Junk` folder
-* [Training Rspamd with Dovecot antispam plugin, part 1](https://kaworu.ch/blog/2014/03/25/dovecot-antispam-with-rspamd/)<sup>[1](#fn1)</sup> - this tutorial describes how to train rspamd automatically using the `antispam` pluging of the `dovecot` IMAP server
+* [Training Rspamd with Dovecot antispam plugin, part 1](https://kaworu.ch/blog/2014/03/25/dovecot-antispam-with-rspamd/)<sup>[1](#fn1)</sup> - this tutorial describes how to train Rspamd automatically using the `antispam` plugin of the `dovecot` IMAP server
 * [Training Rspamd with Dovecot antispam plugin, part 2](https://kaworu.ch/blog/2015/10/12/dovecot-antispam-with-rspamd-part2/)<sup>[1](#fn1)</sup> - continuation of the previous tutorial
 
 <a name="fn1">1.</a> antispam plugin is deprecated, use [IMAPSieve](https://wiki.dovecot.org/HowTo/AntispamWithSieve) instead
diff --git a/doc/tutorials/migrate_sa.md b/doc/tutorials/migrate_sa.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Migrating from SA
+title: Migrating from SpamAssassin
 ---
 # Migrating from SpamAssassin to Rspamd
 

diff --git a/doc/tutorials/quickstart.md b/doc/tutorials/quickstart.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Quickstart
+title: Quick start
 ---
 
 # Rspamd quick start

diff --git a/doc/tutorials/redis_replication.md b/doc/tutorials/redis_replication.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Bayesian statistics and fuzzy storage replication with multi-instance Redis backend
+title: Multi-instance Redis replication
 ---
 # Bayesian statistics and fuzzy storage replication with multi-instance Redis backend
 

diff --git a/doc/tutorials/site_contributing.md b/doc/tutorials/site_contributing.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Contributing to rspamd.com web-site
+title: Contributing to web-site
 ---
 # Contributing to rspamd.com web-site
 

diff --git a/doc/tutorials/stunnel_setup.md b/doc/tutorials/stunnel_setup.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Setting up encrypted tunnel using stunnel
+title: Setup stunnel to protect Redis
 ---
 # Setting up encrypted tunnel using stunnel