Tools of the Documentation Team
Table of contents
Search indexer
The search indexer code can be found in repository https://github.com/TYPO3-Documentation/t3docs-search-indexer
It can be deployed by running https://github.com/TYPO3-Documentation/t3docs-search-indexer/blob/main/.github/workflows/docs-search.yml
A general reindexing can only be triggered by employees of the TYPO3 GmbH at the time of writing.
Preferred TYPO3 versions can be updated by requiring a new version of
t3docs/ via Composer.
The assets for the search result page can be updated by setting the latest renderguides version in https://github.com/TYPO3-Documentation/t3docs-search-indexer/blob/main/config/services.yaml#L19 ff.
api.typo3.org
Landing page
A template generates the landing page of https://api.typo3.org/:
The file versions. beside this template lists the versions of the
API. Each night, the workflow in the next section renders the page and copies
it to the web root as index..
Generated API per version
The content per version https://api.typo3.org/main, https://api.typo3.org/12.4 etc is generated with phpDocumentor. The theme is defined in this repository: https://github.com/TYPO3-Documentation/render-guides/tree/main/packages/typo3-api
The rendering is triggered by this workflow which we in the Documentation Team can change: https://github.com/TYPO3-Documentation/t3docs-ci-deploy/blob/main/.github/workflows/api-typo3-org.yml
Attention
This workflow is running automatically for max 60 days then it has to be restarted manually