Skip to content

[TASK] Document search indexer #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
linawolf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[TASK] Document search indexer #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Documentation/Maintainers/NewMajorCoreVersion.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:navigation-title: New major Core version

.. include:: /Includes.rst.txt
.. _new-major-core-versions:

Expand Down Expand Up @@ -64,12 +66,12 @@ new eLTS versions of all repositories:
:caption: Documentation/Includes.rst.txt

.. You can put central messages to display on all pages here

.. attention::
TYPO3 v12 has reached end-of-life as of April 30th 2026 and
is no longer being maintained. Use the version switcher on the top
left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading?
You can purchase Extended Long Term Support (ELTS) for TYPO3 v12 here:
`TYPO3 ELTS <https://typo3.com/services/extended-support-elts>`__.
Expand Down
31 changes: 30 additions & 1 deletion Documentation/Maintainers/Tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
.. include:: /Includes.rst.txt
.. index:: Changes; Backporting
.. _tools_of_the_documentation_team:
.. _tools-of-the-documentation-team:

===============================
Tools of the Documentation Team
===============================

.. contents:: Table of contents

.. _tools-of-the-documentation-team-search-indexer:

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/typo3-version-handling` 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.

.. _tools-of-the-documentation-team-api:

api.typo3.org
=============

.. _tools-of-the-documentation-team-api-landing:

Landing page
------------

Expand All @@ -26,6 +53,8 @@ rendered output.
The workflow responsible for replacing the landing page is
https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage/blob/main/.github/workflows/apihome.yml

.. _tools-of-the-documentation-team-api-landing-generation:

Generated API per version
-------------------------

Expand Down