docs: document version.json setup and fix config-{env}.json examples#77
Merged
Conversation
- Add version.json creation steps to Quick-Start, Your-First-App, and
Project-Structure guides; explain getAppCode/Name/Version() getters
and the Monolog channel / storage path side-effect of 'code'
- Fix all config-{env}.json examples to use correct top-level keys
(application.global.*, logger.* instead of app.*, logging.*)
- Remove redundant "version" key from config.json tutorial example
- Add \n to line_format in all logger file-driver examples and document
the Linux/Docker line-ending requirement in Configuration.md and the
Getting-Started guides
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
version.jsoncreation steps to Quick-Start, Your-First-App, and Project-Structure guides — explainsgetAppCode()/getAppName()/getAppVersion()and the Monolog channel / storage path side-effect ofcodeconfig-{env}.jsonexamples to use correct top-level keys (application.global.*,logger.*) instead of the wrongapp.*/logging.*keys that didn't match the actual skeleton"version"key from the tutorialconfig.jsonexample (canonical location is nowversion.json)\ntoline_formatin all logger file-driver examples and document the Linux/Docker/Unix line-ending requirement inConfiguration.mdand the Getting-Started guidesTest plan
doc/Getting-Started/Quick-Start.md— version.json section presentdoc/Getting-Started/Your-First-App.md— Step 0 (version.json) present; Step 5 config uses correct keysdoc/Getting-Started/Project-Structure.md— version.json in directory tree and config section; correct config-dev.json exampledoc/User-Guide/Configuration.md— version.json section at top;\nin line_format examples with note