Closed alexander-nitsche closed 2 years ago
[TASK] Reference manual's start page with :doc:<manual>:Index
t3docs-tools (task-git-fetch-prune)$ ./bashScripts/get-repos.sh all all
t3docs-tools (task-git-fetch-prune)$ ./bashScripts/search-repos.sh "grep -rnE ':ref:\`([^:]*):start\`' --exclude-dir='.git' --exclude-dir='Documentation-GENERATED-temp' *" typo3-documentation
------------------------------------------------------------------------
typo3-documentation/DocsTypo3Org-Homepage/main: 21 search result(s)
------------------------------------------------------------------------
Documentation/Home/References.rst:18: .. rubric:: :ref:`t3coreapi:start`
Documentation/Home/References.rst:59: .. rubric:: :ref:`t3tca:start`
Documentation/Home/References.rst:80: .. rubric:: :ref:`t3tsconfig:start`
Documentation/Home/References.rst:104: .. rubric:: :ref:`t3tsref:start`
Documentation/Home/References.rst:128: .. rubric:: :ref:`t3viewhelper:start`
Documentation/Home/References.rst:157::ref:`t3coreapi:start`.
Documentation/Home/References.rst:171: :Description: Outdated. Core v9 version and above have been integrated into :ref:`t3coreapi:start`
Documentation/Home/ExtensionManuals.rst:39: * :ref:`t3extbasebook:start`
Documentation/Home/About/UsingThisSite/Index.rst:19:like :ref:`t3start:start`.
Documentation/Home/About/UsingThisSite/Index.rst:31:* :ref:`references`: A list of core documentation manuals, including :ref:`t3coreapi:start`
Documentation/Home/About/UsingThisSite/Index.rst:59:As soon as you go to a manual (e.g. :ref:`t3start:start`), you leave the "glue pages"
Documentation/Home/About/UsingThisSite/Index.rst:111:When you are reading a manual, for example the :ref:`t3start:start`, you can select
Documentation/Home/About/UsingThisSite/Index.rst:132:reading :ref:`t3start:start`, then search will only search within this manual.
Documentation/Home/About/News/2018/Index.rst:259:* The :ref:`t3tsconfig:start` received a major overhaul. This document
Documentation/Home/About/News/2018/Index.rst:261: :ref:`t3tsref:start` and the :ref:`TCA Reference <t3tca:start>`.
Documentation/Home/About/News/2020/Index.rst:22:The menu of :ref:`t3coreapi:start` was considerably changed during and after
Documentation/Home/About/News/2020/Index.rst:173:Fluid from the :ref:`t3extbasebook:start` to "TYPO3 Explained".
Documentation/Home/About/News/2019/Index.rst:132: contribution. This has now been moved to :ref:`h2document:start` and
Documentation/Home/About/News/2019/Index.rst:166:The :ref:`t3start:start` was updated for TYPO3 9.5.
Documentation/Home/About/News/2019/Index.rst:202:manual :ref:`h2document:start` to help you get started, such as:
Documentation/Home/About/News/2019/Index.rst:328: or follow the :ref:`t3contribute:start`
------------------------------------------------------------------------
typo3-documentation/t3docs-examples/10.4: 1 search result(s)
------------------------------------------------------------------------
Documentation/Settings.cfg:58:# :ref:`t3contribute:start` will link to start page of Contribution Guide
------------------------------------------------------------------------
typo3-documentation/t3docs-examples/8.7: 1 search result(s)
------------------------------------------------------------------------
Documentation/Settings.cfg:58:# :ref:`t3contribute:start` will link to start page of Contribution Guide
------------------------------------------------------------------------
typo3-documentation/t3docs-examples/9.5: 1 search result(s)
------------------------------------------------------------------------
Documentation/Settings.cfg:58:# :ref:`t3contribute:start` will link to start page of Contribution Guide
------------------------------------------------------------------------
typo3-documentation/T3DocTeam/main: 32 search result(s)
------------------------------------------------------------------------
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:20: - :Manual: :ref:`t3l10n:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:23: - :Manual: :ref:`t3install:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:26: - :Manual: :ref:`t3security:start` (Merged into TYPO3 Explained)
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:32: - :Manual: :ref:`t3contribute:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:35: - :Manual: :ref:`t3extbasebook:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:38: - :Manual: :ref:`t3extbase:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:41: - :Manual: :ref:`t3start:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:44: - :Manual: :ref:`t3editors:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:47: - :Manual: :ref:`t3ts45:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:50: - :Manual: :ref:`t3templating:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:59: - :Manual: :ref:`t3tca:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:62: - :Manual: :ref:`t3tsconfig:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:65: - :Manual: :ref:`t3tsref:start`
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:101: - :Manual: :ref:`h2document:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:36: - :Manual: :ref:`t3l10n:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:41: - :Manual: :ref:`t3install:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:46: - :Manual: :ref:`t3sitepackage:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:51: - :Manual: :ref:`t3contribute:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:56: - :Manual: :ref:`t3extbasebook:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:66: - :Manual: :ref:`t3extbase:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:71: - :Manual: :ref:`t3start:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:76: - :Manual: :ref:`t3editors:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:81: - :Manual: :ref:`t3ts45:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:86: - :Manual: :ref:`t3templating:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:101: - :Manual: :ref:`t3tca:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:106: - :Manual: :ref:`t3tsconfig:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:111: - :Manual: :ref:`t3tsref:start`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:221: - :Manual: :ref:`h2document:start`
Documentation/OverviewOfManuals/00ListOfManualsAbout.rst:45: - :Manual: :ref:`h2document:start` (Guide)
Documentation/OverviewOfManuals/00ListOfManualsAbout.rst:70: :Comment: :ref:`h2document:start` now being used as main resource for contributors.
Documentation/OverviewOfManuals/00ListOfManualsAbout.rst:73: links to :ref:`h2document:start`.
Documentation/OverviewOfManuals/00ListOfManualsAbout.rst:80: :ref:`h2document:start` (see startpage).
------------------------------------------------------------------------
typo3-documentation/tea/main: 1 search result(s)
------------------------------------------------------------------------
Documentation/Settings.cfg:48:# :ref:`t3contribute:start` will link to start page of Contribution Guide
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Example-ExtensionManual/main: 1 search result(s)
------------------------------------------------------------------------
Documentation/Installation/Index.rst:13:for example the :ref:`t3install:start`.
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Guide-ContributionWorkflow/main: 4 search result(s)
------------------------------------------------------------------------
Documentation/AddingDocumentation/Index.rst:245:Once a new TYPO3 release comes out, the main documentation (e.g. :ref:`t3coreapi:start`,
Documentation/AddingDocumentation/Index.rst:246::ref:`t3tca:start` etc.) must be updated.
Documentation/AddingDocumentation/Index.rst:263:(e.g. for the system extension *core*) is maintained within the :ref:`t3coreapi:start`.
Documentation/Appendix/ResourcesForEditors/Index.rst:14:* :ref:`h2document:start` (official guide)
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Guide-HowToDocument/main: 14 search result(s)
------------------------------------------------------------------------
Documentation/WritingDocForExtension/ContributeToSystemExtension.rst:20:* The :ref:`t3contribute:start` explains the **contribution workflow** for the core.
Documentation/BasicPrinciples.rst:35: like :ref:`t3coreapi:start`.
Documentation/BasicPrinciples.rst:103:folder. A "manual" can be a tutorial, such as the :ref:`t3start:start`, a guide,
Documentation/RenderingDocs/RenderWithDockerCompose.rst:40: this, for example the :ref:`t3contribute:start`
Documentation/GeneralConventions/HowToUpdateDocs.rst:13:Once a new TYPO3 release comes out, the main documentation (for example :ref:`t3coreapi:start`,
Documentation/GeneralConventions/HowToUpdateDocs.rst:14::ref:`t3tca:start` etc.) must be updated.
Documentation/GeneralConventions/HowToUpdateDocs.rst:165:See :ref:`t3start:start`.
Documentation/GeneralConventions/ReviewInformation.rst:101:* :ref:`t3start:start`.
Documentation/WritingDocsOfficial/GithubMethod.rst:24: the :ref:`t3start:start` or you want to add some new content
Documentation/WritingDocsOfficial/GithubMethod.rst:25: to the :ref:`t3install:start`.
Documentation/WritingDocsOfficial/HowYouCanHelp.rst:117:Replace outdated images, for example in the :ref:`t3tsconfig:start`
Documentation/WritingDocsOfficial/HowYouCanHelp.rst:152:* :ref:`t3extbasebook:start` : This currently needs some work in all branches. Check if the text
Documentation/WritingDocsOfficial/HowYouCanHelp.rst:158:* :ref:`t3coreapi:start`: The same applies as for :ref:`t3extbasebook:start` except that
Documentation/GitHub/Index.rst:24::ref:`t3coreapi:start`) is contained in a GitHub repository.
------------------------------------------------------------------------
Total: 76 search result(s)
------------------------------------------------------------------------
and
t3docs-tools (task-git-fetch-prune)$ ./bashScripts/search-repos.sh "grep -rnE ':ref:\`([^<\`]*)<([^:]*):start>\`' --exclude-dir='.git' --exclude-dir='Documentation-GENERATED-temp' *" typo3-documentation
------------------------------------------------------------------------
typo3-documentation/DocsTypo3Org-Homepage/main: 28 search result(s)
------------------------------------------------------------------------
Documentation/Home/SystemExtensions.rst:19::ref:`TYPO3 Explained <t3coreapi:start>`. For Extbase and Fluid, please see
Documentation/Home/SystemExtensions.rst:20::ref:`Developing TYPO3 Extensions with Extbase and Fluid <t3extbasebook:start>`.
Documentation/Home/References.rst:111: :ref:`TypoScript in 45 Minutes <t3ts45:start>` tutorial.
Documentation/Home/CreatingManagingContent.rst:60: .. rubric:: :ref:`Localizing Pages & Content <t3l10n:start>`
Documentation/Home/CreatingManagingContent.rst:80: .. rubric:: :ref:`Forms <ext_form:start>`
Documentation/Home/OverviewInclude.rst.txt:44: * :ref:`Editors Tutorial <t3editors:start>` explains the creation and management of pages and content.
Documentation/Home/OverviewInclude.rst.txt:49: * :ref:`Localization Guide <t3l10n:start>` covers everything needed to add additional languages to a
Documentation/Home/OverviewInclude.rst.txt:68: * :ref:`Sitepackages <t3sitepackage:start>` allow you to bundle your Fluid templates and other site assets into a single, reusable extension.
Documentation/Home/OverviewInclude.rst.txt:83: in :ref:`TYPO3 Explained <t3coreapi:start>`
Documentation/Home/OverviewInclude.rst.txt:144: * :ref:`TYPO3 Explained <t3coreapi:start>` contains detailed information
Documentation/Home/OverviewInclude.rst.txt:167: * :ref:`Localization Guide <t3l10n:start>`
Documentation/Home/About/News/2016/Index.rst:30:<t3tsref:objects-optionSplit>` in the :ref:`TypoScript reference <t3tsref:start>`.
Documentation/Home/About/News/2016/Index.rst:44:Until recently the :ref:`File Abstraction Layer Reference <t3fal:start>` was
Documentation/Home/About/News/2016/Index.rst:116:The :ref:`TYPO3 Frontend Localization Guide <t3l10n:start>` manual
Documentation/Home/About/News/2016/Index.rst:174:The :ref:`TYPO3 Services References <t3services:start>` manual is finally up to date again
Documentation/Home/About/News/2016/Index.rst:213:The :ref:`Inside TYPO3 Reference <t3inside:start>`
Documentation/Home/About/News/2017/Index.rst:65:The :ref:`TCA Reference <t3tca:start>` got a major overhaul and should be ready for TYPO3 v8 LTS now.
Documentation/Home/About/News/2017/Index.rst:84:to :ref:`TYPO3 API documentation <t3coreapi:start>`.
Documentation/Home/About/News/2018/Index.rst:65::ref:`TYPO3 Explained <t3coreapi:start>`: This document gained more and more aspects over time
Documentation/Home/About/News/2018/Index.rst:68:* One main entry point: :ref:`TYPO3 Explained <t3coreapi:start>` becomes *the* main document where
Documentation/Home/About/News/2018/Index.rst:85: into :ref:`TYPO3 Explained <t3coreapi:start>` gives us the opportunity to merge this stuff around and
Documentation/Home/About/News/2018/Index.rst:103:* All added / changed properties of v9 are reflected in :ref:`TYPO3 Explained <t3coreapi:start>` and
Documentation/Home/About/News/2018/Index.rst:117: improves the :ref:`Contribution workflow <t3contribute:start>` document. Thanks a ton for this!
Documentation/Home/About/News/2018/Index.rst:254: :ref:`TYPO3 Core API <t3coreapi:start>`. The Core API document more and more evolves
Documentation/Home/About/News/2018/Index.rst:261: :ref:`t3tsref:start` and the :ref:`TCA Reference <t3tca:start>`.
Documentation/Home/About/News/2020/Index.rst:183:We made several changes to the :ref:`TypoScript reference <t3tsref:start>` and documentation for the
Documentation/Home/Templating.rst:42: .. rubric:: :ref:`Sitepackages <t3sitepackage:start>`
Documentation/Home/ConfiguringTYPO3.rst:42: .. rubric:: :ref:`TypoScript in 45 Minutes <t3ts45:start>`
------------------------------------------------------------------------
typo3-documentation/T3DocTeam/main: 2 search result(s)
------------------------------------------------------------------------
Documentation/OverviewOfManuals/00ListOfManualsMaintainer.rst:56: - :Manual: :ref:`Core API <t3coreapi:start>`
Documentation/OverviewOfManuals/00ListOfManualsReview.rst:96: - :Manual: :ref:`Core API <t3coreapi:start>`
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/10.4: 6 search result(s)
------------------------------------------------------------------------
Documentation/4-FirstExtension/4-make-products-persistent.rst:37: options in the :ref:`TCA Reference <t3tca:start>`
Documentation/4-FirstExtension/4-make-products-persistent.rst:92: You can find a complete listing of all options at :ref:`TYPO3 Core APIs <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:23: Online-documentation :ref:`TCA Reference <t3tca:start>`
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:141:mentioned TYPO3-Online documentation for the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:485:online and to the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:582:Nevertheless, the Online documentation of the :ref:`TYPO3-Core API <t3coreapi:start>` describes the
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/11.5: 6 search result(s)
------------------------------------------------------------------------
Documentation/4-FirstExtension/4-make-products-persistent.rst:56: options in the :ref:`TCA Reference <t3tca:start>`
Documentation/4-FirstExtension/4-make-products-persistent.rst:116: You can find a complete listing of all options at :ref:`TYPO3 Core APIs <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:27: Online-documentation :ref:`TCA Reference <t3tca:start>`
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:157:mentioned TYPO3-Online documentation for the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:536:online and to the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:640:Nevertheless, the online documentation of the :ref:`TYPO3-Core API <t3coreapi:start>` describes the
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/8.7: 3 search result(s)
------------------------------------------------------------------------
Documentation/4-FirstExtension/4-make-products-persistent.rst:49: You find the documentation for the *Table-Configuration-Array* in the :ref:`TCA Reference <t3tca:start>`
Documentation/4-FirstExtension/4-make-products-persistent.rst:113: You can find a complete listing of all options at :ref:`TYPO3 Core APIs <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:23: Online-documentation :ref:`TCA Reference <t3tca:start>`
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/9.5: 6 search result(s)
------------------------------------------------------------------------
Documentation/4-FirstExtension/4-make-products-persistent.rst:38: options in the :ref:`TCA Reference <t3tca:start>`
Documentation/4-FirstExtension/4-make-products-persistent.rst:93: You can find a complete listing of all options at :ref:`TYPO3 Core APIs <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:23: Online-documentation :ref:`TCA Reference <t3tca:start>`
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:141:mentioned TYPO3-Online documentation for the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:485:online and to the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:582:Nevertheless, the Online documentation of the :ref:`TYPO3-Core API <t3coreapi:start>` describes the
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Book-ExtbaseFluid/main: 4 search result(s)
------------------------------------------------------------------------
Documentation/4-FirstExtension/4-make-products-persistent.rst:116: You can find a complete listing of all options at :ref:`TYPO3 Core APIs <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:157:mentioned TYPO3-Online documentation for the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:536:online and to the :ref:`TYPO3-Core API <t3coreapi:start>`.
Documentation/6-Persistence/2-configure-the-backends-inputforms.rst:640:Nevertheless, the online documentation of the :ref:`TYPO3-Core API <t3coreapi:start>` describes the
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Example-ExtensionManual/main: 1 search result(s)
------------------------------------------------------------------------
Documentation/Templates/Override.rst:14:provided by TYPO3 can be found in the :ref:`ViewHelper Reference <t3viewhelper:start>`
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Guide-Installation/8.7: 1 search result(s)
------------------------------------------------------------------------
Documentation/Upgrade/UpgradeToLts/Index.rst:37::ref:`rte_ckeditor <ext_rte_ckeditor:start>`. If you for now still want to continue using the old editor,
------------------------------------------------------------------------
typo3-documentation/TYPO3CMS-Tutorial-Editors/7.6: 6 search result(s)
------------------------------------------------------------------------
fr_FR-7.6.bak/NextSteps/Index.rst:11::ref:`Guide de localisation<t3l10n:start>`. Il contient
fr_FR-7.6.bak/NextSteps/Index.rst:17:en suivant le :ref:`tutoriel TypoScript en 45 minutes <t3ts45:start>`
fr_FR-7.6.bak/NextSteps/Index.rst:18:qui est une préparation pour le :ref:`tutoriel d'intégration <t3templating:start>`
fr_FR-7.6.bak/Pages/PageProperties/Index.rst:130::ref:`Guide de localisation Frontend <t3l10n:start>`.
fr_FR-7.6.bak/Introduction/Index.rst:29:Nous supposons que vous avez parcouru le tutoriel de :ref:`démarrage rapide <t3start:start>`
fr_FR-7.6.bak/AccessControl/Login/Index.rst:174:décrites dans :ref:`son propre manuel <felogin:start>`.
------------------------------------------------------------------------
Total: 63 search result(s)
------------------------------------------------------------------------
Mention related documentation in abstracts like in https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/:
Add basic set of badges to README files like
[![Latest Stable Version](https://poser.pugx.org/<package-name>/v/stable.svg)](https://extensions.typo3.org/extension/<extension-key>/)
[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg?style=flat-square)](https://get.typo3.org/version/11)
[![Total Downloads](https://poser.pugx.org/<package-name>/d/total.svg)](https://packagist.org/packages/<package-name>)
[![Monthly Downloads](https://poser.pugx.org/<package-name>/d/monthly)](https://packagist.org/packages/<package-name>)
Add support properties to composer.json like
"homepage": "<project-home>",
"support": {
"docs": "<project-docs>",
"issues": "<project-issues>",
"source": "<project-repository>"
}
Check that docs.typo3.org URL is using dashes instead of underscores correctly (composer package name instead of extension key).
Check that TER page is having "Extension Manual" instead of "External Manual" and ensure the old manuals at https://docs.typo3.org/typo3cms/extensions/<extension-key>/<version>/
are gone.
All PRs of agreeing maintainers merged.
During the first documentation standard run (see #181 and #182) some additional todos came up that have to be re-applied in a follow-up run to an excerpt of the repos of the first run.