typo3-documentation / typo3cms-exceptions Goto Github PK

For example https://docs.typo3.org/typo3cms/exceptions/master/en-us/Exceptions/1478113471.html should not exist anymore as the related reST file in PR #8.

• docs page: https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1476107941.html
• source: https://docs.typo3.org/typo3cms/exceptions/main/en-us/_sources/Exceptions/1476107941.rst.txt

source:

Bare minimum example:

.. code-block::yaml

   services:
     _defaults:
       # ...
       autoconfigure: true
       # ...

   # ...



[TYPO3 LTS 10] - [2021.05.05]
====================================

rendered:

Problem

When an exceptions is thrown, the link to the exception page is displayed. When I followed it, i got a page with misleading text:

An Error occurred.
Most likely the exception you are trying to access is not a valid TYPO3 Core exception but rather caused by a 3rd-party extension.
...

https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/Index.html

but it is a valid TYPO3 exception for TYPO3 v12 (see below).

The URL for the exception is: https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1639821269.html

Context of exception

vendor/typo3/cms-fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php line 142:

// Throw if not an extbase request
                throw new \RuntimeException(
                    'ViewHelper f:flashMessages needs an extbase Request object to resolve the Queue identifier magically.'
                    . ' When not in extbase context, set attribute "queueIdentifier".',
                    1639821269
                );

• https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1476107941.html

Probably the __ missing after closing backtick.

https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1616175867.html

See also: :docs:t3coreapi:Changelog/11.3/Feature-93825-RateLimitingForFailedLogins.html.

points to the exception page itself. I guess it should be https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.3/Feature-93825-RateLimitingForFailedLogins.html

• https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1616175847.html
  • page source: https://docs.typo3.org/typo3cms/exceptions/main/en-us/_sources/Exceptions/1616175847.rst.txt

• see other page source: https://docs.typo3.org/typo3cms/exceptions/main/en-us/_sources/Exceptions/1476107295.rst.txt

Even when running the GitHub action CI manually, the current state of reST documents is not reflected as HTML pages in the TYPO3 documentation.

For example:

1. The build status on the production server shows many outdated warnings that have been fixed some days ago: .
2. The page 1278450972.rst has been updated today, but the published page 1278450972.html shows "Last updated: Nov 29, 2021 09:37" and does not contain the updated lines.

Someone with access to both GitHub workflows and the production server should have a look here, to find out, where the freshly rendered pages get lost.

e.g. https://docs.typo3.org/typo3cms/exceptions/master/en-us/Exceptions/1375955684.html

Most of the sections (or all?) refer to older TYPO3 version. For some, the problem may still apply to newer versions. For some, it will definitely not (e.g. the top hint which refers to a security bulletin from 2013).

Should hints that only apply to older, no longer supported TYPO3 versions be removed, moved to bottom of page?

https://docs.typo3.org/typo3cms/exceptions/main/en-us/Exceptions/1436717322.html

This exception text provides misleading information:

• .env is of no use if dotenv-connector is not used
• environment variables can also be defined elsewhere (e.g. in Webserver configuration)
• BASE_DOMAIN is of no use unless BASE_DOMAIN is the variable which has been defined. Any other variable name can be used, see https://docs.typo3.org/c/typo3/cms-core/11.5/en-us/Changelog/9.5/Feature-86409-AllowUsageOfEnvironmentVariablesInSiteConfiguration.html
• this is a solution for only one possible error.
• deleting typo3temp/Cache is not useful if Composer is used (the suggestion with .env implies that it is)

Also, I noticed the original text contained more context which had been removed, see: https://github.com/TYPO3-Documentation/TYPO3CMS-Exceptions/blame/d23df932963463949139656542de5f17a212d712/Documentation/Exceptions/1436717322.rst

The context might have been helpful here, it shows that it is a very specific suggestion for one specific usecase.

All main branches of TYPO3 documentation have been renamed from master to main. Reflect in code accordingly.

It would probably be too much work to change them all right away, but if we have a proposed structure (and a link to it in the help bannner for each exception page), at least some of the existing and new messages might comply.

For example, have some subheaders which are always the same, e.g.

• cause of error (reason)
• fix / workaround
• references (e.g. issues)

There may be several reasons, e.g. see https://docs.typo3.org/typo3cms/exceptions/master/en-us/Exceptions/1375955684.html

Should you add the TYPO3 version where this occured?

I currently get this message:

The repository https://github.com/TYPO3-Documentation/t3docs-exception-pages
provided a application to create missing exception code pages in this repository,
wrapped around a emulated web application simulating core exception code pages.

No current active contributor really knows the deployment ways, and it seams that
the web application kickof is not used by contributors directly.

Therefore, the logic to scan TYPO3 core releases for exception codes and than ensure
that corresponding exception code pages are created based on an template should be
added directly to this repository.

That eleminates a (under) documented system no one really understands and a complex,
splitted workflow.

The tool should be usable locally but also as a automatic GitHub Action workflow in
a scheduled fashion to remove the human interaction requirement after TYPO3 releases.