docs: document the application cache and its backends - #52
Open
anoziere wants to merge 4 commits into
Open
Conversation
Merged
14 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
getting-started/application-cache.md, and its copy underversioned_docs/version-3.0: what the application cache is and how it differs from the container cache and from an HTTP proxy cache, how to point it at Redis, Valkey or Memcached withTHELIA_CACHE_DSN, what each pool holds and what emptying it costs, how installations are kept apart withTHELIA_CACHE_PREFIX_SEED, the eviction policy to choose in production and what it does to API sessions, how to check that it works, and a troubleshooting list.getting-started/configuration.md: the Caching section now separates the container cache from the application cache and links to the new page, instead of stating that the cache is invar/cache/and configured inconfig/packages/cache.yaml.api/authentication.md: refresh tokens are stored in thethelia.cache.securitypool, which survives a deployment and a cache clear, with a link to the new page for the backend and the eviction policy.getting-started/configuration.md: theconfig/packages/listing was missing seven files a 3.0 install actually ships and is now the real one.Every command on the new page was run on a 3.0 install with demo data, in both modes.
This documents thelia/thelia#3892 and is to be merged with the next core release.
Test plan
npm ci && npm run buildsucceeds. The new page renders in both the current and the 3.0 versioned docs, and adds no broken link or broken anchor; the ones the build reports are the pre-existing2.xloop pages.var/pools/dev, with the catalog pool enabled:cache:clearleaves all 16 entries in place,thelia:cache:clearand the back office button take the 14 ofthelia.cache.data_accessto 0 and leave the refresh token and the rate limit counter, and the refresh endpoint answers 200 after each.docs/andversioned_docs/version-3.0/are byte identical for the three pages.