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.
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
docs: add example composer.json
for required cache adapters
#81
docs: add example composer.json
for required cache adapters
#81
Conversation
With this example, it is possible to only require those adapters which are required by the project. Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
composer.json
composer.json
to v2.10
@boesing These are migration notes, right? I would suggest to create a page in the documentation and add this information there. Additionally, a link to the migration page should be added in the readme file. |
@froschdesign No, this is just an information on how to configure a current 2.10 based project to not install all unnecessary cache adapters pre-3.0. So, we dont have to migrate all adapters to PHP 8 at once and let people decide on which adapters they use and to provide PRs only for these adapters. So in the end, it is forward compatibility to 3.0 aswell as PHP 8 not having to be supported on every adapter for 2.10+. |
Then the description with the example should be added to the installation page. |
@froschdesign Just to be sure I understand this correct, we dont want to provide informations in I've also seen that this package is not using the |
Oh no. In the optimum case we should provide the same informations (like intro, installation, etc.) in the readme file (here on GitHub and after the installation in the vendor directory) and in the documentation, without duplicating the content. Because duplicating always leads to forgotten updates on one side.
Yes. I would provide a solution that allows custom content to be added, like the Composer configuration. |
composer.json
to v2.10composer.json
for required cache adapters
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small changes are needed:
- For headline we uses the "Chicago Manual of Style Capitalization Rules"
- MD022 - Headings should be surrounded by blank lines
Bummer! I sweared to myself that I will keep an eye on these chicago headlines 😂 |
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢
Description
With this example, it is possible to only require those adapters which are required by the project.