[Cache] Document "framework.cache" nodes #7245
Conversation
geoffrey-brier force-pushed the framework-cache-directory branch 3 times, most recently from 3364073 to be1404b Compare geoffrey-brier force-pushed the framework-cache-directory branch 2 times, most recently from 75a1819 to 492250f Compare 
| This needs to be fixed, it appears that the first few changed lines are broken. Status: needs work |
| Al cache settings should be documented instead of documenting only one of them. |
| * :ref:`cache <reference-serializer-cache>` | ||
| * :ref:`enable_annotations <reference-serializer-enable_annotations>` | ||
| * :ref:`name_converter <reference-serializer-name_converter>` | ||
| * `cache`_ |
There was a problem hiding this comment.
Maybe here is why it's failing? It's misaligned...
geoffrey-brier changed the title geoffrey-brier force-pushed the framework-cache-directory branch from 492250f to 716f826 Compare geoffrey-brier force-pushed the framework-cache-directory branch 11 times, most recently from 206ccc7 to fdd3b98 Compare 
| * `storage_id`_ | ||
| * `handler_id`_ | ||
| * `name`_ | ||
| * :ref:`name <session-name>` |
There was a problem hiding this comment.
What was the reason for this change?
There was a problem hiding this comment.
Because I added another name reference. As this leads to a warning (considered as an error by the build), I figured out that you have rename all your references this way.
There was a problem hiding this comment.
Isn't it enough to only do that for the other added label with the same name?
There was a problem hiding this comment.
Tested it and it failed ^^
There was a problem hiding this comment.
Too bad, this means that the anchor used currently (http://symfony.com/doc/current/reference/configuration/framework.html#name) won't work in the future. Maybe @wouterj has an idea how we can prevent the loss.
There was a problem hiding this comment.
@xabbuh adding the .. _name: label manually before the existing name option wouldn't work?
There was a problem hiding this comment.
@javiereguiluz Might cause conflicts as these labels are global and not limited to the current document.
There was a problem hiding this comment.
@javiereguiluz sounds like your solution worked :)
geoffrey-brier force-pushed the framework-cache-directory branch from fdd3b98 to c1525c0 Compare geoffrey-brier force-pushed the framework-cache-directory branch 4 times, most recently from 86f93e9 to cdf1046 Compare geoffrey-brier force-pushed the framework-cache-directory branch from cdf1046 to 03d3e35 Compare 
| | ||
| **type**: ``string`` **default**: ``cache.app`` | ||
| | ||
| A cache adapter. |
There was a problem hiding this comment.
This description should be improved to explain the purpose of this option. Thanks!
geoffrey-brier force-pushed the framework-cache-directory branch 3 times, most recently from 05dcff7 to ff46950 Compare geoffrey-brier force-pushed the framework-cache-directory branch from ff46950 to 9cb31b2 Compare | @javiereguiluz Any idea why the deployment to platform.sh fails ? In any case, the PR is good for another review :) |
| @geoffrey-brier all the builds are failing ... but our friends at Platform.sh have already fixed the issue and provided two possible solutions. We're deciding which one to use. |
| .. note:: | ||
| | ||
| The framework bundle ships with multiple adapters: apcu, doctrine, system, | ||
| filesystem, psr6, and redis. |
There was a problem hiding this comment.
This note content should be added to the setting description imo
| default_psr6_provider | ||
| ..................... | ||
| | ||
| **type**: ``string`` **default**: ``%kernel.cache_dir%/pools`` |
| | ||
| **type**: ``string`` | ||
| | ||
| The service name to use as your default Doctrine provider. |
There was a problem hiding this comment.
Maybe add the service name of this "default provider": "This is available as cache.doctrine service."
| | ||
| **type**: ``string`` **default**: ``%kernel.cache_dir%/pools`` | ||
| | ||
| The service name to use as your default PSR-6 provider. |
There was a problem hiding this comment.
Same here: "This is available as cache.psr6 service"
| | ||
| **type**: ``string`` **default**: ``redis://localhost`` | ||
| | ||
| The dsn to use by the Redis provider. |
There was a problem hiding this comment.
...and here: "This is available as cache.redis service"
| Your pool name must differ from ``cache.app`` or ``cache.system``. | ||
| | ||
| adapter | ||
| ####### |
| Thank you very much for this great PR @geoffrey-brier and congratulations for your first contribution to the Symfony documentation. I have merged your PR into the |
| @xabbuh Thank you, very glad I could help ;) |
7 participants
No description provided.