[TASK] Adapt to getting started overview (#70)

* [TASK] Adapt to getting started overview

* Delete line

Documentation/Index.rst

@@ -6,39 +6,90 @@
 <project>
 =========
 
-:Extension key:
-    <extension-key>
+Welcome to the example manual of the example extension <extension-key>.
 
-:Package name:
-    <package-name>
+This guide provides an introduction to an example extension <extension-key>.
+It shows the basic setup of a manual describing how to use the extension
+<extension-key>. You can use it as a starting point or a building guideline to
+create your own documentation for your extension.
 
-:Version:
-    |release|
+The first overview should give the user a good starting point to quickly find the
+information that the user is looking for.
 
-:Language:
-    en
+----
 
-:Author:
-    <author>
+..  card-grid::
+    :columns: 1
+    :columns-md: 2
+    :gap: 4
+    :class: pb-4
+    :card-height: 100
 
-:License:
-    This document is published under the
-    `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
-    license.
+    ..  card:: Introduction
 
-:Rendered:
-    |today|
+        You can add a small introduction to the <extension-key>. If you are new
+        to writing a documentation in general this section provides a good
+        starting point to look at.
 
-----
+        ..  card-footer:: :ref:`Get an overview <introduction>`
+            :button-style: btn btn-secondary stretched-link
 
-<abstract>
+    ..  card:: Installation
 
-----
+        Provide which steps should be done to install the <extension-key>
+        properly. We recommend to give enough hints to kindly guide the user
+        through this process.
+
+        ..  card-footer:: :ref:`View the installation steps <installation>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Configuration
+
+        In this section you should cover all the needed configurations to set up
+        the <extension-key> correctly. Additionally you should present an
+        overview about all available configurations one can set up in <extension-key>.
+
+        ..  card-footer:: :ref:`Learn how to configure the extension <configuration>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Templates
+
+        In this section you can describe how a user can use its custom
+        templates. Additionally you can present and describe what your custom
+        viewhelpers are doing. Last but not least you can provide some example
+        templates.
+
+        ..  card-footer:: :ref:`Inspect the templating <templates>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: The editor section
+
+        This section is specialised for editors. Editors find everything that is
+        useful for them using the <extension-key> in this section.
+
+        ..  card-footer:: :ref:`Discover editor specific tools <for-editors>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: The developers corner
+
+        Use this section to provide examples of code or any information
+        that would be deemed relevant to a developer. For example explain how
+        a certain feature was implemented.
+
+        ..  card-footer:: :ref:`Get to know the developers corner <developer>`
+            :button-style: btn btn-secondary stretched-link
 
-**Table of Contents:**
+    ..  card:: Troubleshooting
+
+        Use this section for informing about troubleshooting. If the users of
+        your extension encountered any problems they should be able to find
+        information to solve their problems in this section.
+
+        ..  card-footer:: :ref:`Learn how to troubleshoot <known-problems>`
+            :button-style: btn btn-secondary stretched-link
 
 ..  toctree::
-    :maxdepth: 2
+    :hidden:
     :titlesonly:
 
     Introduction/Index
@@ -55,3 +106,32 @@
     :hidden:
 
     Sitemap
+
+----
+
+:Extension key:
+    <extension-key>
+
+:Package name:
+    <package-name>
+
+:Version:
+    |release|
+
+:Language:
+    en
+
+:Author:
+    <author>
+
+:License:
+    This document is published under the
+    `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
+    license.
+
+:Rendered:
+    |today|
+
+
+
+

Documentation/Localization.de_DE/Index.rst

@@ -6,39 +6,93 @@
 <project-de>
 ============
 
-:Extension-Schlüssel:
-    <extension-key>
+Willkommen zur Beispielanleitung der Beispielerweiterung <Extension-Schlüssel>.
 
-:Paketname:
-    <package-name>
+Diese Anleitung gibt eine Einführung in die Beispielerweiterung <Extension-Schlüssel>.
+Sie zeigt den grundlegenden Aufbau einer Anleitung, die die Verwendung der Erweiterung
+<Erweiterung-Schlüssel> erklärt. Sie können sie als Ausgangspunkt oder als Leitfaden verwenden, um
+Ihre eigene Dokumentation für Ihre Erweiterung zu erstellen.
 
-:Version:
-    |release|
+Die erste Übersicht sollte dem Benutzer einen guten Ausgangspunkt bieten, um
+schnell die Informationen zu finden, nach denen er sucht.
 
-:Sprache:
-    de
+----
 
-:Autor:
-    <author>
+..  card-grid::
+    :columns: 1
+    :columns-md: 2
+    :gap: 4
+    :class: pb-4
+    :card-height: 100
 
-:Lizenz:
-    Dieses Dokument wird unter der
-    `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
-     Lizenz veröffentlicht.
+    ..  card:: Einführung
 
-:Erstellt:
-    |today|
+        Sie sollten eine kleine Einführung in Ihre Erweiterung geben.
+        Wenn Sie neu sind im Dokumentationen schreiben, sollte dieser Abschnitt
+        einen guten Ausgangspunkt für Sie darstellen.
 
-----
+        ..  card-footer:: :ref:`Bekommen Sie einen Überblick <introduction>`
+            :button-style: btn btn-secondary stretched-link
 
-<abstract-de>
+    ..  card:: Installation
 
-----
+        Beschreiben Sie welche Schritte man folgen muss, um die Erweiterung
+        erfolgreich zu installieren. Geben Sie genügend Hinweise, um den Nutzer
+        durch diesen Prozess zu begleiten.
+
+        ..  card-footer:: :ref:`Installieren Sie Ihre Erweiterung <installation>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Konfiguration
+
+        In diesem Kapitel sollten Sie alle benötigten Konfigurationen erwähnen,
+        die man braucht, um die Erweiterung zu verwenden. Zudem sollten Sie dem
+        Nutzer einen Überblick geben über alle möglichen Konfigurationen, die
+        es in Ihrer Erweiterung gibt.
+
+        ..  card-footer:: :ref:`Konfigurieren Sie Ihre Erweiterung <configuration>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Templates
+
+        Hier sollte beschrieben werden, wie der Nutzer seine eigenen Fluid
+        Templates nutzen kann. Zudem können Sie hier auch Ihre Viewhelper
+        erklären und zeigen wie man sie nutzt. Außerdem können Sie Beispieltemplates
+        zeigen.
+
+        ..  card-footer:: :ref:`Templating relevante Informationen <templates>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Für Editoren
+
+        Dieses Kapitel enhält alle wichtigen Informationen, die ein Editor
+        wissen sollte. Und zwar nicht die allgemeinen, sondern die, die für Ihre
+        Erweiterung relevant sind.
+
+        ..  card-footer:: :ref:`Endecken Sie die Editor Werkzeuge <for-editors>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Für Entwickler
 
-**Inhaltsverzeichnis:**
+        Dieses Kapitel können Sie verwenden, um Beispielcode zu zeigen oder um
+        Informationen zu geben, die für einen Entwickler relevant sind. Zum
+        Beispiel können Sie hier erklären, wie Sie ein spezielles Feature erstellt
+        haben.
+
+        ..  card-footer:: :ref:`Entdecken Sie alles Relevante für den Entwickler <developer>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Troubleshooting
+
+        Informieren Sie hier über Troubleshooting. Wenn ein Nutzer Probleme
+        hat sollte er hier sinnvolle Informationen finden, um die Lösung für
+        sein Problem zu finden.
+
+        ..  card-footer:: :ref:`Probleme und ihre Lösungen <known-problems>`
+            :button-style: btn btn-secondary stretched-link
 
 ..  toctree::
-    :maxdepth: 2
+    :hidden:
     :titlesonly:
 
     Introduction/Index
@@ -55,3 +109,28 @@
     :hidden:
 
     Sitemap
+
+----
+
+:Extension-Schlüssel:
+    <extension-key>
+
+:Paketname:
+    <package-name>
+
+:Version:
+    |release|
+
+:Sprache:
+    de
+
+:Autor:
+    <author>
+
+:Lizenz:
+    Dieses Dokument wird unter der
+    `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
+     Lizenz veröffentlicht.
+
+:Erstellt:
+    |today|