Update documentation.

Lacr1ma · Dec 7, 2019 · 00263de · 00263de
1 parent a7dcafb
commit 00263de
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 0 deletions.
diff --git a/Documentation/AdministratorManual/Index.rst b/Documentation/AdministratorManual/Index.rst
@@ -0,0 +1,24 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+
+
+.. _admin-manual:
+
+For administrators
+==================
+
+.. only:: html
+
+	This chapter describes how to manage the extension from a superuser point of view.
+
+.. toctree::
+	:maxdepth: 5
+	:titlesonly:
+
+	Installation/Index
+	Update/Index
+	Configuration/Index
+	Templates/Index
diff --git a/Documentation/AdministratorManual/Installation/Index.rst b/Documentation/AdministratorManual/Installation/Index.rst
@@ -0,0 +1,36 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+
+.. _installation:
+
+Installation
+============
+
+
+#. Get the extension
+
+   #. **Use composer**: Use `composer require lms/routes`.
+
+Latest version from git
+-----------------------
+You can get the latest version from git by using the git command:
+
+.. code-block:: bash
+
+   git clone https://github.com/Lacr1ma/routes.git
+
+Preparation: Include static TypoScript
+--------------------------------------
+
+The extension ships some TypoScript code which needs to be included.
+
+#. Switch to the root page of your site.
+
+#. Switch to the **Template module** and select *Info/Modify*.
+
+#. Press the link **Edit the whole template record** and switch to the tab *Includes*.
+
+#. Select **LMS: Routes (routes)** at the field *Include static (from extensions):*
diff --git a/Documentation/AdministratorManual/Update/Index.rst b/Documentation/AdministratorManual/Update/Index.rst
@@ -0,0 +1,26 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. _update
+
+Updating
+--------
+If you update EXT:routes to a newer version, please read this section carefully!
+
+Versioning
+^^^^^^^^^^
+It uses a 3-number versioning scheme: *<major>.<minor>.<patch>*
+
+- Major: Major breaking changes
+- Minor: Minor breaking changes
+- Patch: No breaking changes
+
+Before an update
+^^^^^^^^^^^^^^^^
+
+Before you start the update procedure, please read the changelog of all versions which have been
+released in the meantime!
+
+Furthermore it is **always** a good idea to do updates on a dedicated test installation or at least create a database backup.
diff --git a/Documentation/DeveloperManual/Index.rst b/Documentation/DeveloperManual/Index.rst
@@ -0,0 +1,21 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+
+
+.. _developer-manual:
+
+For developers
+==============
+
+.. only:: html
+
+	This chapter describes how to use the extension from a developer point of view.
+
+.. toctree::
+	:maxdepth: 5
+	:titlesonly:
+
+	Contribute/Index