Skip to content
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

Conversation

boesing
Copy link
Member

@boesing boesing commented Apr 2, 2021

Q A
Documentation yes

Description

With this example, it is possible to only require those adapters which are required by the project.

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>
@boesing boesing changed the title docs: add example composer.json docs: add example composer.json to v2.10 Apr 2, 2021
@froschdesign
Copy link
Member

@boesing
Sorry for the late response!

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.

@boesing
Copy link
Member Author

boesing commented Apr 7, 2021

@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.
I dont think we can provide PHP 8 support to all adapters as most of them are already not supported on PHP 7 either.

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+.
Thats the idea behind this example.

@froschdesign
Copy link
Member

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.

Then the description with the example should be added to the installation page.

@boesing
Copy link
Member Author

boesing commented Apr 7, 2021

@froschdesign Just to be sure I understand this correct, we dont want to provide informations in README.md but via docs only?

I've also seen that this package is not using the installation template other packages are using. So yes, I can extend the installation page here, but how to achieve that in packages which are using the installation template?
Shouldn't we use the template in each package?

@froschdesign
Copy link
Member

@boesing

Just to be sure I understand this correct, we dont want to provide informations in README.md but via docs only?

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.
So far, we don't have a (good) solution for this, so it reduces to some text and links.

Shouldn't we use the template in each package?

Yes. I would provide a solution that allows custom content to be added, like the Composer configuration.

@boesing boesing changed the title docs: add example composer.json to v2.10 docs: add example composer.json for required cache adapters Apr 8, 2021
Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
Copy link
Member

@froschdesign froschdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/book/installation.md Outdated Show resolved Hide resolved
docs/book/installation.md Outdated Show resolved Hide resolved
docs/book/installation.md Outdated Show resolved Hide resolved
@boesing
Copy link
Member Author

boesing commented Apr 26, 2021

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>
@boesing boesing added this to the 2.10.2 milestone Apr 28, 2021
@boesing boesing added this to To do in Laminas cache satellites via automation Apr 28, 2021
Copy link
Member

@froschdesign froschdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

Laminas cache satellites automation moved this from To do to In progress Apr 28, 2021
@boesing boesing merged commit 612bae3 into laminas:2.10.x Apr 29, 2021
Laminas cache satellites automation moved this from In progress to Done Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants