Make documentation about useCacheHash clearer (and about cHash in general)

TYPO3-Documentation / TYPO3CMS-Reference-Typoscript

The TypoScript Reference (TSref) is a true reference describing the core Content Objects and functions available for Template building using the TypoScript template engine.

https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/

11 stars 173 forks source link

Make documentation about useCacheHash clearer (and about cHash in general) #293

Closed susannemoog closed 3 years ago

susannemoog commented 4 years ago

see https://forge.typo3.org/issues/90783#change-419730

We should explain what the setting does better and reference the general cHash documentation (if it exists) or write one explaining:

What is the cHash
Which settings influence it (TYPO3_CONF_VARS, Routing, Caching)
Usage in UriBuilder / Fluid
--> in v10 a lot of the old stuff is deprecated / rewritten so maybe now is the time :)

sypets commented 4 years ago

I don't think the "general cHash documentation" exists, not on docs.typo3.org. But, shouldn't that rather be in T3 Explained? Maybe change "Caching Framework" to general "Caching" chapter there and add Introduction.

sypets commented 4 years ago

About chash, there is some info:

Mysteries of chash (2005, by Kasper)
b13: Caching part 2 (2020, by Benni)

linawolf commented 3 years ago

@susannemoog @sypets how shall we solve this issue? Or can it be closed?

susannemoog commented 3 years ago

I think I wrote that documentation at some point based on a few changes in the core. See https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/ApiOverview/CachingFramework/Index.html#caching-variants-or-what-is-a-cache-hash & https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/pull/1043

linawolf commented 3 years ago

Ok so lets close this then