[TASK] Improve menu structure and navigation titles

TYPO3-Documentation · Jul 28, 2024 · db2495d · db2495d
1 parent caa4058
commit db2495d
Show file tree

Hide file tree

Showing 110 changed files with 116 additions and 104 deletions.
diff --git a/Documentation/HowToAddTranslation/Index.rst → ...on/Advanced/HowToAddTranslation/Index.rst b/Documentation/HowToAddTranslation/Index.rst → ...on/Advanced/HowToAddTranslation/Index.rst
diff --git a/.../GeneralConventions/ReviewInformation.rst → Documentation/Advanced/ReviewInformation.rst b/.../GeneralConventions/ReviewInformation.rst → Documentation/Advanced/ReviewInformation.rst
diff --git a/Documentation/About.rst → Documentation/Basics/About.rst b/Documentation/About.rst → Documentation/Basics/About.rst
diff --git a/Documentation/BasicPrinciples.rst → Documentation/Basics/BasicPrinciples.rst b/Documentation/BasicPrinciples.rst → Documentation/Basics/BasicPrinciples.rst
diff --git a/...n/GeneralConventions/CodingGuidelines.rst → ...s/GeneralConventions/CodingGuidelines.rst b/...n/GeneralConventions/CodingGuidelines.rst → ...s/GeneralConventions/CodingGuidelines.rst
@@ -50,7 +50,7 @@ Example:
 .. code-block:: rst
   :linenos:
 
-   .. image:: /Images/a4.jpg
+   .. image:: /_Images/a4.jpg
       :alt: Left floating image
       :target: https://typo3.org
       :class: with-shadow

diff --git a/.../GeneralConventions/ContentStyleGuide.rst → .../GeneralConventions/ContentStyleGuide.rst b/.../GeneralConventions/ContentStyleGuide.rst → .../GeneralConventions/ContentStyleGuide.rst
diff --git a/Documentation/GeneralConventions/Format.rst → ...tion/Basics/GeneralConventions/Format.rst b/Documentation/GeneralConventions/Format.rst → ...tion/Basics/GeneralConventions/Format.rst
diff --git a/...mentation/GeneralConventions/Glossary.rst → ...on/Basics/GeneralConventions/Glossary.rst b/...mentation/GeneralConventions/Glossary.rst → ...on/Basics/GeneralConventions/Glossary.rst
diff --git a/...eneralConventions/GuidelinesForImages.rst → ...eneralConventions/GuidelinesForImages.rst b/...eneralConventions/GuidelinesForImages.rst → ...eneralConventions/GuidelinesForImages.rst
@@ -124,13 +124,13 @@ To get the icons
 ----------------
 
 Either download the zipfile and extract it.
-You can find the download link on https://github.com/TYPO3-Documentation/Images,
+You can find the download link on https://github.com/TYPO3-Documentation/_Images,
 
 Or clone the repository:
 
 .. code-block:: bash
 
-   git clone https://github.com/TYPO3-Documentation/Images
+   git clone https://github.com/TYPO3-Documentation/_Images
 
 
 The icons will be in images/final/icons.
@@ -168,7 +168,7 @@ Examples
 
    SVG image with rectangles and numbers
 
-.. figure:: /Images/edit_me_on_github+shadow.svg
+.. figure:: /_Images/edit_me_on_github+shadow.svg
    :class: with-shadow
    :alt: Image with arrow
 

diff --git a/Documentation/GeneralConventions/Index.rst → ...ation/Basics/GeneralConventions/Index.rst b/Documentation/GeneralConventions/Index.rst → ...ation/Basics/GeneralConventions/Index.rst
diff --git a/...mentation/GeneralConventions/Licenses.rst → ...on/Basics/GeneralConventions/Licenses.rst b/...mentation/GeneralConventions/Licenses.rst → ...on/Basics/GeneralConventions/Licenses.rst
diff --git a/...ntation/GeneralConventions/ReadmeFile.rst → .../Basics/GeneralConventions/ReadmeFile.rst b/...ntation/GeneralConventions/ReadmeFile.rst → .../Basics/GeneralConventions/ReadmeFile.rst
@@ -18,23 +18,23 @@ example:
 
     ..  group-tab:: With placeholders
 
-        ..  include:: /CodeSnippets/FileStructure/ReadmeRst.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/ReadmeRst.rst.txt
 
     ..  group-tab:: Third-party extension
 
-        ..  include:: /CodeSnippets/FileStructure/Examples/IndexRst.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/Examples/IndexRst.rst.txt
 
     ..  group-tab:: System extension
 
-        ..  include:: /CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt
 
     ..  group-tab:: Official manual
 
-        ..  include:: /CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt
 
     ..  group-tab:: Markdown
 
-        ..  include:: /CodeSnippets/FileStructure/ReadmeMd.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/ReadmeMd.rst.txt
 
 
 .. _readme-rst-badges:
@@ -50,11 +50,11 @@ monthly download rate and the supported TYPO3 versions:
 
     ..  group-tab:: reStructured Text
 
-        ..  include:: /CodeSnippets/FileStructure/Badges.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/Badges.rst.txt
 
     ..  group-tab:: Markdown
 
-        ..  include:: /CodeSnippets/FileStructure/BadgesMd.rst.txt
+        ..  include:: /_CodeSnippets/FileStructure/BadgesMd.rst.txt
 
 
 Remove this field if the project is no extension or package.

diff --git a/...ation/GeneralConventions/ReviewPolicy.rst → ...asics/GeneralConventions/ReviewPolicy.rst b/...ation/GeneralConventions/ReviewPolicy.rst → ...asics/GeneralConventions/ReviewPolicy.rst
diff --git a/...GeneralConventions/images/backend-raw.png → ...GeneralConventions/images/backend-raw.png b/...GeneralConventions/images/backend-raw.png → ...GeneralConventions/images/backend-raw.png
diff --git a/...nventions/images/backend-with-boxes-2.svg → ...nventions/images/backend-with-boxes-2.svg b/...nventions/images/backend-with-boxes-2.svg → ...nventions/images/backend-with-boxes-2.svg
diff --git a/...Conventions/images/backend-with-boxes.png → ...Conventions/images/backend-with-boxes.png b/...Conventions/images/backend-with-boxes.png → ...Conventions/images/backend-with-boxes.png
diff --git a/...ons/images/github-getting-started-raw.png → ...ons/images/github-getting-started-raw.png b/...ons/images/github-getting-started-raw.png → ...ons/images/github-getting-started-raw.png
diff --git a/Documentation/HowToGetHelp.rst → Documentation/Basics/HowToGetHelp.rst b/Documentation/HowToGetHelp.rst → Documentation/Basics/HowToGetHelp.rst
diff --git a/...ion/WritingDocsOfficial/HowYouCanHelp.rst → ...tation/Howto/Contribute/HowYouCanHelp.rst b/...ion/WritingDocsOfficial/HowYouCanHelp.rst → ...tation/Howto/Contribute/HowYouCanHelp.rst
@@ -1,3 +1,5 @@
+:navigation-title: Help
+
 ..  include:: /Includes.rst.txt
 
 ..  _docs-official-how-you-can-help:
@@ -130,7 +132,7 @@ Here are some examples:
 
 *   :ref:`Check out sequence diagram on new page about request handling <t3coreapi:request-handling>`
 
-    ..  figure:: /Images/diagram.png
+    ..  figure:: /_Images/diagram.png
         :alt: Example of a sequence diagram about request handling
         :class: with-shadow
 

diff --git a/Documentation/WritingDocsOfficial/Index.rst → Documentation/Howto/Contribute/Index.rst b/Documentation/WritingDocsOfficial/Index.rst → Documentation/Howto/Contribute/Index.rst
@@ -1,3 +1,5 @@
+:navigation-title: Contribute
+
 .. include:: /Includes.rst.txt
 .. index:: Official documentation
 .. _contribute:
@@ -50,9 +52,8 @@ There are two different ways in which you can make your changes before submittin
       :ref:`docs-contribute-git-docker`
 
 
-.. toctree::
-   :hidden:
+..  toctree::
+    :hidden:
+    :glob:
 
-   GithubMethod
-   LocalEditing
-   HowYouCanHelp
+    *
diff --git a/...tion/WritingDocsOfficial/LocalEditing.rst → Documentation/Howto/EditLocal.rst b/...tion/WritingDocsOfficial/LocalEditing.rst → Documentation/Howto/EditLocal.rst
@@ -1,3 +1,5 @@
+:navigation-title: Edit Locally
+
 .. include:: /Includes.rst.txt
 .. index:: Official documentation; Local editing
 .. _docs-contribute-git-docker:
@@ -28,7 +30,7 @@ the ability to experiment and preview your changes locally before submitting the
 
    From here, select the "Fork" button in the upper right corner of the page.
 
-   .. image:: /Images/github-fork.png
+   .. image:: /_Images/github-fork.png
       :class: with-shadow
 
 3. Clone the forked repository

diff --git a/...tion/WritingDocsOfficial/GithubMethod.rst → Documentation/Howto/EditOnGithub.rst b/...tion/WritingDocsOfficial/GithubMethod.rst → Documentation/Howto/EditOnGithub.rst
@@ -1,3 +1,5 @@
+:navigation-title: Edit on GitHub
+
 .. include:: /Includes.rst.txt
 .. index:: pair: Official documentation; "Edit on GitHub"
 .. _docs-contribute-github-method:
@@ -28,15 +30,15 @@ Workflow #1: "Edit on GitHub"
    At the top right of every page you will find an icon that says "Edit me on Github".
    Selecting this link will take you to that pages repository on GitHub.
 
-   .. image:: /Images/edit_me_on_github.png
+   .. image:: /_Images/edit_me_on_github.png
       :class: with-border with-shadow
 
 4. Fork the repository:
 
    Click on the green button to fork the repository. This will clone the repository
    into your GitHub account, ready for you to make your changes in your browser.
 
-   .. image:: /Images/github-edit-fork.png
+   .. image:: /_Images/github-edit-fork.png
       :class: with-border with-shadow
 
 5. Make your changes:
@@ -45,7 +47,7 @@ Workflow #1: "Edit on GitHub"
    The *"Indent mode: Spaces"* and *"Indent size: 4"*
    values should already be set - do not alter these.
 
-   .. image:: /Images/github-edit-window.png
+   .. image:: /_Images/github-edit-window.png
       :class: with-border with-shadow
 
 
@@ -61,7 +63,7 @@ Workflow #1: "Edit on GitHub"
 
    You can go back and make further changes at any time, select the Edit file tab to continue editing.
 
-   .. image:: /Images/github-edit-preview.png
+   .. image:: /_Images/github-edit-preview.png
       :class: with-border with-shadow
 
 8. Finalize your changes:
@@ -70,20 +72,20 @@ Workflow #1: "Edit on GitHub"
    a short (but meaningful) description that outlines the changes you have made and click "Propose
    file change"
 
-   .. image:: /Images/github-propose-file-changes.png
+   .. image:: /_Images/github-propose-file-changes.png
       :class: with-border with-shadow
 
 9. Create pull request:
 
    GitHub will show you an overview of your changes. If you are happy with
    them, select "Create pull request".
 
-   .. image:: /Images/github-comparing-changes.png
+   .. image:: /_Images/github-comparing-changes.png
       :class: with-border with-shadow
 
    Finally, create your pull request:
 
-   .. image:: /Images/github-create-pull-request2.png
+   .. image:: /_Images/github-create-pull-request2.png
       :class: with-border with-shadow
 
 10. You're done!
@@ -108,13 +110,13 @@ See `June 2018: Developer Appreciation Day
 for an example.
 
 
-.. image:: /Images/dad-with-image.png
+.. image:: /_Images/dad-with-image.png
    :target: https://typo3.com/blog/june-2018-developer-appreciation-day-dad/?utm_medium=TYPO3%2BBlog&utm_source=Blog%2BPost%2B-%2BJune%2B2018%3A%2BDeveloper%2BAppreciation%2BDay%2B%28DAD%29
    :class: with-border with-shadow
 
 Scroll down to "Improving documentation":
 
-.. image:: /Images/dad-improve-docs.png
+.. image:: /_Images/dad-improve-docs.png
    :target: https://typo3.com/blog/june-2018-developer-appreciation-day-dad/?utm_medium=TYPO3%2BBlog&utm_source=Blog%2BPost%2B-%2BJune%2B2018%3A%2BDeveloper%2BAppreciation%2BDay%2B%28DAD%29
    :class: with-border with-shadow
 

diff --git a/Documentation/Migration/Index.rst → Documentation/Howto/Migration/Index.rst b/Documentation/Migration/Index.rst → Documentation/Howto/Migration/Index.rst
@@ -1,3 +1,5 @@
+:navigation-title: Migrate
+
 ..  include:: /Includes.rst.txt
 ..  index::
     Documentation; Migration
@@ -323,7 +325,7 @@ The link is leading to
 We have to click the symbol next to the heading and copy the correct link
 which is the one for restructured text
 
-.. image:: /Images/get_link.png
+.. image:: /_Images/get_link.png
     :class: with-shadow
     :width: 600px
 
@@ -348,7 +350,7 @@ https://github.com/TYPO3-Documentation/render-guides/blob/main/Makefile
 
 A small example :file:`Makefile`:
 
-..  literalinclude:: /CodeSnippets/_Makefile
+..  literalinclude:: /_CodeSnippets/_Makefile
     :language: plaintext
     :caption: Makefile
 
@@ -376,7 +378,7 @@ ensure the extension's documentation renders without warnings.
 An example workflow on GitHub would be established via this file in
 :file:`.github/workflows/documentation.yml`:
 
-..  literalinclude:: /CodeSnippets/_documentation.yml
+..  literalinclude:: /_CodeSnippets/_documentation.yml
     :caption: .github/workflows/documentation.yml
 
 

diff --git a/Documentation/RenderingDocs/Index.rst → Documentation/Howto/RenderingDocs/Index.rst b/Documentation/RenderingDocs/Index.rst → Documentation/Howto/RenderingDocs/Index.rst
@@ -1,3 +1,5 @@
+:navigation-title: Render
+
 .. include:: /Includes.rst.txt
 .. Index::
     pair: Documentation; Rendering

diff --git a/...Extension/ContributeToSystemExtension.rst → ...Extension/ContributeToSystemExtension.rst b/...Extension/ContributeToSystemExtension.rst → ...Extension/ContributeToSystemExtension.rst
@@ -33,7 +33,7 @@ see :ref:`overview-of-types`.
    comment in your pull request with information about where to find your patch
    on Gerrit.
 
-   .. image:: /Images/github-gerrit.png
+   .. image:: /_Images/github-gerrit.png
       :class: with-shadow
       :target: https://github.com/typo3/typo3/pull/172#issuecomment-494721296
 

diff --git a/...nsion/ContributeToThirdPartyExtension.rst → ...nsion/ContributeToThirdPartyExtension.rst b/...nsion/ContributeToThirdPartyExtension.rst → ...nsion/ContributeToThirdPartyExtension.rst
@@ -59,15 +59,15 @@ Method 2: Find the Source on https://extensions.typo3.org
    3. Select the extension
 
 
-      .. image:: /Images/ter_news2.png
+      .. image:: /_Images/ter_news2.png
          :alt: Link: Show manual
          :target: https://extensions.typo3.org/?L=0&id=1&tx_solr%5Bq%5D=news
          :class: with-shadow
          :width: 600px
 
    4. Click take a look in the code
 
-      .. image:: /Images/take-a-look-in-the-code.png
+      .. image:: /_Images/take-a-look-in-the-code.png
          :alt: Link: Take a look in the code
          :target: https://github.com/georgringer/news
          :class: with-shadow
@@ -101,7 +101,7 @@ Method 2: Find rendered manual on https://extensions.typo3.org
 
    3. Click on "Show Manual"
 
-      .. image:: /Images/ter_news.png
+      .. image:: /_Images/ter_news.png
          :alt: Link: Show manual
          :target: https://docs.typo3.org/typo3cms/extensions/news/
          :class: with-shadow

diff --git a/Documentation/WritingDocForExtension/FAQ.rst → ...tion/Howto/WritingDocForExtension/FAQ.rst b/Documentation/WritingDocForExtension/FAQ.rst → ...tion/Howto/WritingDocForExtension/FAQ.rst
@@ -31,7 +31,7 @@ If you are missing documentation for some extension versions we have a
 Why Does the Documentation not provide a title?
 ===============================================
 
-.. image:: /Images/missing-title.png
+.. image:: /_Images/missing-title.png
    :class: with-shadow
 
 Refer to :ref:`migrate` in order to fix this issue.
@@ -175,7 +175,7 @@ How do I get an "Edit on GitHub" button?
 Why might you want an "Edit on GitHub" button on the rendered pages
 of your extension documentation?
 
-.. figure:: /Images/edit_me_on_github+shadow.svg
+.. figure:: /_Images/edit_me_on_github+shadow.svg
    :class: with-shadow
    :alt: "Edit on GitHub" button
 

diff --git a/...entation/WritingDocForExtension/Index.rst → ...on/Howto/WritingDocForExtension/Index.rst b/...entation/WritingDocForExtension/Index.rst → ...on/Howto/WritingDocForExtension/Index.rst
@@ -1,3 +1,5 @@
+:navigation-title: Document extensions
+
 .. include:: /Includes.rst.txt
 .. index:: Documentation; Extension
 .. _writing-doc-for-ext-start:

diff --git a/...ingDocForExtension/ReregisterVersions.rst → ...ingDocForExtension/ReregisterVersions.rst b/...ingDocForExtension/ReregisterVersions.rst → ...ingDocForExtension/ReregisterVersions.rst