From 1ba10692fb1636d17e4c978e6dff35424320f75e Mon Sep 17 00:00:00 2001 From: Sandra Erbel Date: Tue, 27 Aug 2024 16:21:54 +0200 Subject: [PATCH 1/2] [TASK] Adapt to getting started overview --- Documentation/Index.rst | 122 +++++++++++++++++---- Documentation/Localization.de_DE/Index.rst | 121 ++++++++++++++++---- Documentation/Localization.fr_FR/Index.rst | 122 +++++++++++++++++---- 3 files changed, 303 insertions(+), 62 deletions(-) diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 993d491..34debbc 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -6,39 +6,90 @@ ========= -:Extension key: - +Welcome to the example manual of the example extension . -:Package name: - +This guide provides an introduction to an example extension . +It shows the basic setup of a manual describing how to use the extension +. 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: - +.. 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 `__ - license. + .. card:: Introduction -:Rendered: - |today| + You can add a small introduction to the . 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 ` + :button-style: btn btn-secondary stretched-link - + .. card:: Installation ----- + Provide which steps should be done to install the + properly. We recommend to give enough hints to kindly guide the user + through this process. + + .. card-footer:: :ref:`View the installation steps ` + :button-style: btn btn-secondary stretched-link + + .. card:: Configuration + + In this section you should cover all the needed configurations to set up + the correctly. Additionally you should present an + overview about all available configurations one can set up in . + + .. card-footer:: :ref:`Learn how to configure the extension ` + :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 ` + :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 in this section. + + .. card-footer:: :ref:`Discover editor specific tools ` + :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 ` + :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 ` + :button-style: btn btn-secondary stretched-link .. toctree:: - :maxdepth: 2 + :hidden: :titlesonly: Introduction/Index @@ -55,3 +106,32 @@ :hidden: Sitemap + +---- + +:Extension key: + + +:Package name: + + +:Version: + |release| + +:Language: + en + +:Author: + + +:License: + This document is published under the + `Creative Commons BY 4.0 `__ + license. + +:Rendered: + |today| + + + + diff --git a/Documentation/Localization.de_DE/Index.rst b/Documentation/Localization.de_DE/Index.rst index df48753..c6d4186 100644 --- a/Documentation/Localization.de_DE/Index.rst +++ b/Documentation/Localization.de_DE/Index.rst @@ -6,39 +6,93 @@ ============ -:Extension-Schlüssel: - +Willkommen zur Beispielanleitung der Beispielerweiterung . -:Paketname: - +Diese Anleitung gibt eine Einführung in die Beispielerweiterung . +Sie zeigt den grundlegenden Aufbau einer Anleitung, die die Verwendung der Erweiterung + 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: - +.. 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 `__ - 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 ` + :button-style: btn btn-secondary stretched-link - + .. 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 ` + :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 ` + :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 ` + :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 ` + :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 ` + :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 ` + :button-style: btn btn-secondary stretched-link .. toctree:: - :maxdepth: 2 + :hidden: :titlesonly: Introduction/Index @@ -55,3 +109,28 @@ :hidden: Sitemap + +---- + +:Extension-Schlüssel: + + +:Paketname: + + +:Version: + |release| + +:Sprache: + de + +:Autor: + + +:Lizenz: + Dieses Dokument wird unter der + `Creative Commons BY 4.0 `__ + Lizenz veröffentlicht. + +:Erstellt: + |today| diff --git a/Documentation/Localization.fr_FR/Index.rst b/Documentation/Localization.fr_FR/Index.rst index 739c62f..b74d294 100644 --- a/Documentation/Localization.fr_FR/Index.rst +++ b/Documentation/Localization.fr_FR/Index.rst @@ -6,38 +6,95 @@ ============ -:Clé d'extension: - +Bienvenue dans le manuel de l'exemple d'extension . -:Nom du package: - +Ce guide présente un exemple d'extension . Il montre la +configuration de base d'un manuel décrivant comment utiliser l'extension +. Vous pouvez l'utiliser comme point de départ ou comme +ligne directrice pour créer votre propre documentation pour votre extension. -:Version: - |release| +La première vue d'ensemble devrait donner à l'utilisateur un bon point de départ +pour trouver rapidement les informations qu'il recherche. -:Langue: - fr +---- -:Auteur: - +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :class: pb-4 + :card-height: 100 -:Licence: - Ce document est publié sous la licence - `Creative Commons BY 4.0 `__. + .. card:: Introduction -:Généré: - |today| + Vous pouvez ajouter une petite introduction à la . Si + vous n'avez pas l'habitude de rédiger une documentation, cette section + constitue un bon point de départ. ----- + .. card-footer:: :ref:`Vue d'ensemble ` + :button-style: btn btn-secondary stretched-link - + .. card:: Installation ----- + Indiquer les étapes à suivre pour installer correctement la + . Nous recommandons de donner suffisamment d'indications + pour guider l'utilisateur tout au long du processus. + + .. card-footer:: :ref:`Voir les étapes de l'installation ` + :button-style: btn btn-secondary stretched-link + + .. card:: Configuration + + Dans cette section, vous devez présenter toutes les configurations + nécessaires pour configurer correctement la . + En outre, vous devez présenter une vue d'ensemble de toutes + les configurations disponibles que l'on peut définir dans . + + .. card-footer:: :ref:`Apprendre à configurer l'extension ` + :button-style: btn btn-secondary stretched-link + + .. card:: Templates + + Dans cette section, vous pouvez décrire comment un utilisateur peut + utiliser ses modèles personnalisés. En outre, vous pouvez présenter + et décrire ce que font vos viewhelpers personnalisés. Enfin, vous + pouvez fournir des exemples de modèles. + + .. card-footer:: :ref:`Inspecter le modèle ` + :button-style: btn btn-secondary stretched-link + + .. card:: The editor section + + Cette section est spécialisée pour les éditeurs. Les éditeurs trouvent + tout ce qui leur est utile en utilisant les de cette + section. + + .. card-footer:: :ref:`Découvrir les outils spécifiques aux éditeurs ` + :button-style: btn btn-secondary stretched-link + + .. card:: The developers corner + + Utilisez cette section pour fournir des exemples de code ou toute + information jugée pertinente pour un développeur. Par exemple, + expliquer comment une certaine fonctionnalité a été mise en œuvre. + + .. card-footer:: :ref:`Faire connaissance avec le coin des développeurs ` + :button-style: btn btn-secondary stretched-link -**Sommaire:** + .. card:: Troubleshooting + + Utilisez cette section pour informer sur le dépannage. Si les + utilisateurs de votre extension rencontrent des problèmes, ils + devraient pouvoir trouver des informations pour les résoudre dans + cette section. + + .. card-footer:: :ref:`Apprendre à dépanner ` + :button-style: btn btn-secondary stretched-link + +---- .. toctree:: - :maxdepth: 2 + :hidden: :titlesonly: Introduction/Index @@ -54,3 +111,28 @@ :hidden: Sitemap + +---- + +:Clé d'extension: + + +:Nom du package: + + +:Version: + |release| + +:Langue: + fr + +:Auteur: + + +:Licence: + Ce document est publié sous la licence + `Creative Commons BY 4.0 `__. + +:Généré: + |today| + From 90637a668db5af6a66613f92b7070ca7b45f064d Mon Sep 17 00:00:00 2001 From: Sandra Erbel Date: Tue, 27 Aug 2024 16:26:17 +0200 Subject: [PATCH 2/2] Delete line --- Documentation/Localization.fr_FR/Index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/Documentation/Localization.fr_FR/Index.rst b/Documentation/Localization.fr_FR/Index.rst index b74d294..e943eed 100644 --- a/Documentation/Localization.fr_FR/Index.rst +++ b/Documentation/Localization.fr_FR/Index.rst @@ -91,8 +91,6 @@ pour trouver rapidement les informations qu'il recherche. .. card-footer:: :ref:`Apprendre à dépanner ` :button-style: btn btn-secondary stretched-link ----- - .. toctree:: :hidden: :titlesonly: