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

3.x Quick-Start module.config snippet needs improvement. #106

Open
pbcGIS opened this issue Feb 21, 2022 · 4 comments · May be fixed by #109
Open

3.x Quick-Start module.config snippet needs improvement. #106

pbcGIS opened this issue Feb 21, 2022 · 4 comments · May be fixed by #109
Assignees
Labels
Bug Something isn't working Documentation

Comments

@pbcGIS
Copy link
Contributor

pbcGIS commented Feb 21, 2022

https://github.com/laminas/laminas-mvc/blob/3.3.x/docs/book/quick-start.md

This Quick Start installs the skeleton application and adds a new controller route to the "Application." module.

The tutorial includes a snippet that illustrates the addition of a route and controller to the module.config.php .

It would be most helpful to show the additional code in the context of the existing module.config.php

The module.config.php provided with the Skeleton template declares the Application namespace and includes several Laminas classes by name at the top. These declarations cause the explicit path references in the suggested snippet to throw inscrutable errors -- which are needlessly frustrating for the novice Laminas wannabe.

This would work much better if the entire module.config.php was included in the snippet -- perhaps with the new bits highlighted.
Or at least make the snippet compatible with the pre-exitsting file with better remarks about how the pieces are inserted.

I attach a complete module.config.php that demonstrates the quick-start functions.

Thank you.

module.config.php.txt

@pbcGIS pbcGIS added the Bug Something isn't working label Feb 21, 2022
@Ocramius Ocramius added this to the 3.3.3 milestone Feb 21, 2022
@Ocramius
Copy link
Member

Handled in #107, thanks @pbcGIS!

@pbcGIS
Copy link
Contributor Author

pbcGIS commented Feb 21, 2022

Thank you very much! The world will be a happier place!

@froschdesign froschdesign removed this from the 3.3.3 milestone Feb 22, 2022
@froschdesign froschdesign reopened this Feb 22, 2022
@Ocramius
Copy link
Member

Oof, wrong referenced issue indeed. Thanks @froschdesign!

@pbcGIS
Copy link
Contributor Author

pbcGIS commented Feb 22, 2022 via email

@froschdesign froschdesign linked a pull request Feb 24, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants