Final fixes for version 3 #29
Conversation
ServiceManager may pass null as third argument.
docs/book/cookbook/aot-guide.md
Outdated
| @@ -0,0 +1,112 @@ | |||
| # Using AoT In A ZendFramework App | |||
There was a problem hiding this comment.
Whitespace is missing: "Zend Framework"
There was a problem hiding this comment.
See also my question below:
Is this a "zend-expressive application" or "Zend Framework application"?
docs/book/cookbook/aot-guide.md
Outdated
|
|
||
| ## Create project and add zend-di | ||
|
|
||
| For this guide will use an [expressive application](https://docs.zendframework.com/zend-expressive/) |
There was a problem hiding this comment.
Is this a "zend-expressive application" or "Zend Framework application"? I think there's a difference.
There was a problem hiding this comment.
I thought expressive was part of zend framework and an alternative to mvc. Anyway it's a good idea to change the title to make it more clear we're dealing with expressive here. I'll rephrase this paragraph accordingly.
docs/book/cookbook/aot-guide.md
Outdated
| Now add zend-di with composer: | ||
|
|
||
| ```bash | ||
| composer require zendframework/zend-di=^3.0 |
There was a problem hiding this comment.
Why the version constraint?
There was a problem hiding this comment.
I thought it states clearly that this requires 3.0 at minimum and prevents composer to accidentally install zend-di 2.x.
Should there be more explanation about this?
There was a problem hiding this comment.
If version 3.0 is released, then version 3 will be installed automatically. The version constraint is not needed. Remove it and all is fine.
We should not over complicated the documentation.
There was a problem hiding this comment.
I agree with both of you!
I'd suggest demonstrating without the version constant, but adding a note that if v2 gets installed, you should try the above (with constraint) to determine what is blocking it. You might also want to consider adding some verbiage in that note that if you are upgrading from v2, you will need to remove zend-servicemanager-di first.
There was a problem hiding this comment.
Good points.
I totally missed the zend-servicemanager-di conflict. I'll add a Note and hint to the version constraint option as sugessted by @weierophinney
docs/book/cookbook/aot-guide.md
Outdated
| @@ -23,10 +23,11 @@ composer create-project zendframework/zend-expressive-skeleton zend-di-aot-examp | |||
| Pick the components you want to use. As statet above, we will be using Zend ServiceManager | |||
| and a Modular layout for this example. | |||
|
|
|||
| Now add zend-di with composer: | |||
| Now add zend-di and zend-code with composer: | |||
There was a problem hiding this comment.
At this point it is not clear why zend-code is needed. Please add an explanation in the sentence above. Thanks!
|
@froschdesign Thanks for your feedback. I'll check the Details later. |
As stated by @froschdesign, this is dedicated to expressive, so state it clearly in the title.
* Remove the version constraint from composer example * Point out the conflict to zend-servicemanager-di
Final fixes for version 3
|
Thanks, @tux-rampage! Edited for grammar and typography, but looks great! |
This PR contains updates to the documentation and a small incompatibility fix:
I also created an example repository for the app in this guide: https://github.com/lukanetconsult/zend-di-aot-example