-
Notifications
You must be signed in to change notification settings - Fork 7
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
Each component should contain a description of how it can be used in an application #8
Labels
Comments
As |
froschdesign
added a commit
to froschdesign/zend-view
that referenced
this issue
Aug 20, 2019
michalbundyra
pushed a commit
to froschdesign/zend-view
that referenced
this issue
Oct 11, 2019
This was referenced Dec 31, 2019
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
At the moment, most components only describe basic usage without integration and use within an application.
This ends up in recurring questions from users how a component can be used in a zend-mvc-based or zend-expressive application.
Examples
FilterPluginManager
is missing)FormElementManager
is missing)HydratorPluginManager
is missing)InputFilterManager
is missing)ValidatorPluginManager
is missing)Suggestion
We should add for each component a description of how the component can be used in an application. It would be advantageous if we add descriptions for:
The description should covered only a basic example how a component can be integrated in an application. For examples that illustrate full functionality, the tutorials should be used.
The descriptions for application integrations should only be bundles of individual descriptions, which should already exist in the components. Therefore links must be set for all steps.
Requirements
Examples
An example can be found at zend-navigation:
https://docs.zendframework.com/zend-navigation/quick-start/#usage-in-a-zend-mvc-based-application
Another example can be found at zend-i18n (WIP):
https://froschdesign.github.io/zend-documentation-showcase/application-integration/slim/
Already present
For laminas-mvc based applications
See also: https://docs.laminas.dev/tutorials/#application-integrations
For Mezzio based applications
Project
There is a project that tracks progress on this topic: https://github.com/orgs/laminas/projects/3
The text was updated successfully, but these errors were encountered: