From 64732c60b1146ca40032857f00f4418059bb84f5 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 14 Jan 2024 11:57:29 +0100 Subject: [PATCH 01/18] [TASK] Move best practises for additonal readme files --- .../GeneralConventions/FileStructure.rst | 124 ++---------------- .../GeneralConventions/ReadmeFile.rst | 95 ++++++++++++++ 2 files changed, 106 insertions(+), 113 deletions(-) create mode 100644 Documentation/GeneralConventions/ReadmeFile.rst diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index b96764d1..db4d0f10 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -38,7 +38,7 @@ Further conventions are: :file:`.rst.txt'. * Use **CamelCase** for directory and file names, for example: :file:`Documentation/GeneralConventions/FileStructure.rst`. -* Each directory SHOULD have a file called :file:`Index.rst` it is used as +* Each directory SHOULD have a file named :file:`Index.rst` it is used as fallback if a page is not found during switching versions. .. index:: Full documentation @@ -47,129 +47,27 @@ Further conventions are: Full documentation ================== -This is the recommended setup and is commonly used in the official TYPO3 manuals -and extension documentation. +To render a complete documentation manual you need a folder called +:file:`Documentation` with at least an entry point reStrutured Text file called +:file:`Documentation\Index.rst` and a configuration file called +:file:`Documentation\guides.xml`. Add more files as needed -This structure splits the documentation for the VCS host (README.rst) and the -Sphinx theme (Documentation/) and allows full use of a continuously expanded set -of :ref:`custom content elements `, like UML diagrams, which are -only supported by the theme. This structure allows to add multiple pages to -the documentation and build a full page tree. - -The Settings.cfg configuration file allows you to set theme variables, i.e. the -project title, release version and the like. - -Of course, you can also use a README.md instead of a README.rst file as both -markup languages are supported by the common VCS hosts. +You can keep :file:`a README.md` or :file:`README.rst` file with basic +information and a link to the published manual. These files will be commonly +displayed on GitHub and GitLab. .. code-block:: none . + ├── composer.json ├── README.rst └── Documentation - ├── genindex.rst - ├── Includes.rst.txt + ├── About.rst + ├── guides.xml.rst ├── Index.rst - ├── Settings.cfg ├── Sitemap.rst └── .. - -.. index:: File structure; README.rst, README.rst -.. _readme-rst: -.. _about-file: - -Entry point: :file:`README.rst` -------------------------------- - -Full documentation contains both a README.rst and a Documentation/Index.rst -file. To avoid redundancy in both places, the README.rst in this case usually -contains only a summary and links to all aspects of the project, i.e. the VCS -repository, the published documentation and - if available - the TYPO3 Extension -Repository (TER) page to guide the reader to the next steps. This could be for -example: - -.. tabs:: - - .. group-tab:: With placeholders - - .. include:: /CodeSnippets/FileStructure/ReadmeRst.rst.txt - - .. group-tab:: Third party extension - - .. include:: /CodeSnippets/FileStructure/Examples/IndexRst.rst.txt - - .. group-tab:: System extension - - .. include:: /CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt - - .. group-tab:: Official manual - - .. include:: /CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt - - .. group-tab:: Markdown - - .. include:: /CodeSnippets/FileStructure/ReadmeMd.rst.txt - - -.. _readme-rst-badges: - -Badges -^^^^^^ - -Point out interesting statistics of your extension or package in the *badges* -placeholder, which should include the latest release version, the total and -monthly download rate and the supported TYPO3 versions: - -.. tabs:: - - .. group-tab:: Rest - - .. include:: /CodeSnippets/FileStructure/Badges.rst.txt - - .. group-tab:: Markdown - - .. include:: /CodeSnippets/FileStructure/BadgesMd.rst.txt - - -Remove this field if the project is no extension or package. - - -.. _readme-rst-project: - -Project -^^^^^^^ - -The *project* placeholder contains the title of the project. - -Common values are in the official TYPO3 manuals - -#. ` Guide`, e.g. "Installation and Upgrade Guide", - for collections of articles on a specific topic -#. ` Reference`, e.g. "TCA Reference", - for a complete encyclopedia -#. ` Tutorial`, e.g. "Getting Started Tutorial", - for collections of tutorials on a specific topic - -and in TYPO3 system and third-party extensions - -* `TYPO3 extension `, e.g. "TYPO3 extension \`\`extbase\`\`" and - "TYPO3 extension \`\`mask\`\`". - - -.. _readme-rst-abstract: - -Abstract -^^^^^^^^ - -The *abstract* placeholder contains a short and precise description of the -project with as many keywords as possible in as few sentences as possible. It -helps the decision maker to quickly decide whether the project is worth -considering and whether or not to read the full documentation. It should be -aligned with the abstract of Index.rst and - if available - the description -fields of :file:`ext_emconf.php` and :file:`composer.json`. - - .. index:: File structure; Documentation/Index.rst, Index.rst .. _index-rst: .. _start-file: diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst new file mode 100644 index 00000000..bbf47dd2 --- /dev/null +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -0,0 +1,95 @@ + +.. index:: File structure; README.rst, README.rst +.. _readme-rst: +.. _about-file: + +======================================= +:file:`README.rst` or :file:`README.md` +======================================= + +Full documentation contains both a README.rst and a Documentation/Index.rst +file. To avoid redundancy in both places, the README.rst in this case usually +contains only a summary and links to all aspects of the project, i.e. the VCS +repository, the published documentation and - if available - the TYPO3 Extension +Repository (TER) page to guide the reader to the next steps. This could be for +example: + +.. tabs:: + + .. group-tab:: With placeholders + + .. include:: /CodeSnippets/FileStructure/ReadmeRst.rst.txt + + .. group-tab:: Third party extension + + .. include:: /CodeSnippets/FileStructure/Examples/IndexRst.rst.txt + + .. group-tab:: System extension + + .. include:: /CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt + + .. group-tab:: Official manual + + .. include:: /CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt + + .. group-tab:: Markdown + + .. include:: /CodeSnippets/FileStructure/ReadmeMd.rst.txt + + +.. _readme-rst-badges: + +Badges +^^^^^^ + +Point out interesting statistics of your extension or package in the *badges* +placeholder, which should include the latest release version, the total and +monthly download rate and the supported TYPO3 versions: + +.. tabs:: + + .. group-tab:: Rest + + .. include:: /CodeSnippets/FileStructure/Badges.rst.txt + + .. group-tab:: Markdown + + .. include:: /CodeSnippets/FileStructure/BadgesMd.rst.txt + + +Remove this field if the project is no extension or package. + + +.. _readme-rst-project: + +Project +^^^^^^^ + +The *project* placeholder contains the title of the project. + +Common values are in the official TYPO3 manuals + +#. ` Guide`, e.g. "Installation and Upgrade Guide", + for collections of articles on a specific topic +#. ` Reference`, e.g. "TCA Reference", + for a complete encyclopedia +#. ` Tutorial`, e.g. "Getting Started Tutorial", + for collections of tutorials on a specific topic + +and in TYPO3 system and third-party extensions + +* `TYPO3 extension `, e.g. "TYPO3 extension \`\`extbase\`\`" and + "TYPO3 extension \`\`mask\`\`". + + +.. _readme-rst-abstract: + +Abstract +^^^^^^^^ + +The *abstract* placeholder contains a short and precise description of the +project with as many keywords as possible in as few sentences as possible. It +helps the decision maker to quickly decide whether the project is worth +considering and whether or not to read the full documentation. It should be +aligned with the abstract of Index.rst and - if available - the description +fields of :file:`ext_emconf.php` and :file:`composer.json`. From 17206c0a1bec7d29dac9c61d239dc4c0ee72aa70 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:53:43 +0100 Subject: [PATCH 02/18] Update Documentation/GeneralConventions/FileStructure.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/FileStructure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index db4d0f10..ea307868 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -48,7 +48,7 @@ Full documentation ================== To render a complete documentation manual you need a folder called -:file:`Documentation` with at least an entry point reStrutured Text file called +:file:`Documentation` with at least a reStructured Text file as entry point named :file:`Documentation\Index.rst` and a configuration file called :file:`Documentation\guides.xml`. Add more files as needed From 8fb8ed6023d9ce14dc2a026d63d7abecce792fc0 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:53:49 +0100 Subject: [PATCH 03/18] Update Documentation/GeneralConventions/FileStructure.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/FileStructure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index ea307868..969edab9 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -50,7 +50,7 @@ Full documentation To render a complete documentation manual you need a folder called :file:`Documentation` with at least a reStructured Text file as entry point named :file:`Documentation\Index.rst` and a configuration file called -:file:`Documentation\guides.xml`. Add more files as needed +:file:`Documentation\guides.xml`. Add more files as needed. You can keep :file:`a README.md` or :file:`README.rst` file with basic information and a link to the published manual. These files will be commonly From 1a089276b6df2c5fe353a6052a81bb71cfbbe78f Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:53:57 +0100 Subject: [PATCH 04/18] Update Documentation/GeneralConventions/FileStructure.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/FileStructure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index 969edab9..4dad9910 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -52,7 +52,7 @@ To render a complete documentation manual you need a folder called :file:`Documentation\Index.rst` and a configuration file called :file:`Documentation\guides.xml`. Add more files as needed. -You can keep :file:`a README.md` or :file:`README.rst` file with basic +You can keep a :file:`README.md` or :file:`README.rst` file with basic information and a link to the published manual. These files will be commonly displayed on GitHub and GitLab. From c8cb2eb49fb8c37d6b7684575ca9ef42123c2662 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:54:03 +0100 Subject: [PATCH 05/18] Update Documentation/GeneralConventions/FileStructure.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/FileStructure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index 4dad9910..9ebcf7e9 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -53,7 +53,7 @@ To render a complete documentation manual you need a folder called :file:`Documentation\guides.xml`. Add more files as needed. You can keep a :file:`README.md` or :file:`README.rst` file with basic -information and a link to the published manual. These files will be commonly +information and a link to the published manual in the root folder of the extension. These files will be commonly displayed on GitHub and GitLab. .. code-block:: none From 9d8d24e4a635cb1db7559f7727a07f10918ae43f Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:54:20 +0100 Subject: [PATCH 06/18] Update Documentation/GeneralConventions/FileStructure.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/FileStructure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index 9ebcf7e9..f735e4a9 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -63,7 +63,7 @@ displayed on GitHub and GitLab. ├── README.rst └── Documentation ├── About.rst - ├── guides.xml.rst + ├── guides.xml ├── Index.rst ├── Sitemap.rst └── .. From 4ec8b8af1fe5593c08fa5f968d0583e8d2ca62a6 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:54:33 +0100 Subject: [PATCH 07/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index bbf47dd2..12fbfa97 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -7,7 +7,7 @@ :file:`README.rst` or :file:`README.md` ======================================= -Full documentation contains both a README.rst and a Documentation/Index.rst +Full documentation contains both a :file:`README.rst` and a :file:`Documentation/Index.rst` file. To avoid redundancy in both places, the README.rst in this case usually contains only a summary and links to all aspects of the project, i.e. the VCS repository, the published documentation and - if available - the TYPO3 Extension From 278322f0223d0a5f7a1dd69cc7fee01dffae3428 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:54:58 +0100 Subject: [PATCH 08/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 12fbfa97..8fecaf1d 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -8,7 +8,7 @@ ======================================= Full documentation contains both a :file:`README.rst` and a :file:`Documentation/Index.rst` -file. To avoid redundancy in both places, the README.rst in this case usually +file. To avoid redundancy in both places, the :file:`README.rst` in this case usually contains only a summary and links to all aspects of the project, i.e. the VCS repository, the published documentation and - if available - the TYPO3 Extension Repository (TER) page to guide the reader to the next steps. This could be for From 73c7c5af8252ca80b88681f45f8c933efa1b636e Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:55:19 +0100 Subject: [PATCH 09/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 8fecaf1d..da2062e9 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -67,7 +67,7 @@ Project The *project* placeholder contains the title of the project. -Common values are in the official TYPO3 manuals +Common values are, for example, in the official TYPO3 manuals #. ` Guide`, e.g. "Installation and Upgrade Guide", for collections of articles on a specific topic From ea64408ff0158dad659f24c1680ee0193b70c9ca Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:55:26 +0100 Subject: [PATCH 10/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index da2062e9..2a7ba4c3 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -85,7 +85,7 @@ and in TYPO3 system and third-party extensions .. _readme-rst-abstract: Abstract -^^^^^^^^ +======== The *abstract* placeholder contains a short and precise description of the project with as many keywords as possible in as few sentences as possible. It From 4a87511bb725dd3dad156e128ceda3ddb8c2331b Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:55:41 +0100 Subject: [PATCH 11/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 2a7ba4c3..c28bc10a 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -20,7 +20,7 @@ example: .. include:: /CodeSnippets/FileStructure/ReadmeRst.rst.txt - .. group-tab:: Third party extension + .. group-tab:: Third-party extension .. include:: /CodeSnippets/FileStructure/Examples/IndexRst.rst.txt From 52d878945b5490925a15d676fd6b39be0315cfde Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:55:47 +0100 Subject: [PATCH 12/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index c28bc10a..14b1a67a 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -91,5 +91,5 @@ The *abstract* placeholder contains a short and precise description of the project with as many keywords as possible in as few sentences as possible. It helps the decision maker to quickly decide whether the project is worth considering and whether or not to read the full documentation. It should be -aligned with the abstract of Index.rst and - if available - the description +aligned with the abstract of :file:`Index.rst` and - if available - the description fields of :file:`ext_emconf.php` and :file:`composer.json`. From 6556d6ecace7a1ed8ec177dc9973e13c8c33078c Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 17:55:58 +0100 Subject: [PATCH 13/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 14b1a67a..f1d8eb12 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -9,7 +9,7 @@ Full documentation contains both a :file:`README.rst` and a :file:`Documentation/Index.rst` file. To avoid redundancy in both places, the :file:`README.rst` in this case usually -contains only a summary and links to all aspects of the project, i.e. the VCS +contains only a summary and links to all aspects of the project, i.e. the :abbr:`VCS (Version Control System)` repository, the published documentation and - if available - the TYPO3 Extension Repository (TER) page to guide the reader to the next steps. This could be for example: From cd49d410b0bc17b0f0e119fa111d7ec8aa5e22e3 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 18:37:05 +0100 Subject: [PATCH 14/18] Update Documentation/GeneralConventions/FileStructure.rst --- Documentation/GeneralConventions/FileStructure.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/Documentation/GeneralConventions/FileStructure.rst b/Documentation/GeneralConventions/FileStructure.rst index f735e4a9..2410c8ee 100644 --- a/Documentation/GeneralConventions/FileStructure.rst +++ b/Documentation/GeneralConventions/FileStructure.rst @@ -62,7 +62,6 @@ displayed on GitHub and GitLab. ├── composer.json ├── README.rst └── Documentation - ├── About.rst ├── guides.xml ├── Index.rst ├── Sitemap.rst From 761812b18677bf61f2199b222456db1df356af62 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 18:37:34 +0100 Subject: [PATCH 15/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index f1d8eb12..e5d2936d 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -40,7 +40,7 @@ example: .. _readme-rst-badges: Badges -^^^^^^ +====== Point out interesting statistics of your extension or package in the *badges* placeholder, which should include the latest release version, the total and From d01efdb1ffe2384cfec4cd67c2bc86d63de67918 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 18:37:45 +0100 Subject: [PATCH 16/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index e5d2936d..138accb6 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -43,7 +43,7 @@ Badges ====== Point out interesting statistics of your extension or package in the *badges* -placeholder, which should include the latest release version, the total and +placeholder, which may include the latest release version, the total and monthly download rate and the supported TYPO3 versions: .. tabs:: From 5f62ca6ac7cc00c4f8aeac0d59c17936abb2ccfa Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 18:38:55 +0100 Subject: [PATCH 17/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 138accb6..3d30f1eb 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -48,7 +48,7 @@ monthly download rate and the supported TYPO3 versions: .. tabs:: - .. group-tab:: Rest + .. group-tab:: reStructured Text .. include:: /CodeSnippets/FileStructure/Badges.rst.txt From 33760e49191db3984fb1bc64cc08837f439258d1 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 21 Jan 2024 18:39:13 +0100 Subject: [PATCH 18/18] Update Documentation/GeneralConventions/ReadmeFile.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/GeneralConventions/ReadmeFile.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/GeneralConventions/ReadmeFile.rst index 3d30f1eb..06339544 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/GeneralConventions/ReadmeFile.rst @@ -63,7 +63,7 @@ Remove this field if the project is no extension or package. .. _readme-rst-project: Project -^^^^^^^ +======= The *project* placeholder contains the title of the project.