Reorder DoctrineBundle configuration sections #8573
Merged
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.
I think the DoctrineBundle Configuration page is not structured correctly. Here are the current page's sections, along with my comments:
Full Default Configuration
Here the
dbal
conf is presented before theorm
conf (which is perfectly ok). The reader will therefore expect that in the following sections, thedbal
conf is presented first. This is not the case.Configuration Overview
Actually this is orm-only. The section title should be explicit about this.
2.1. Caching Drivers
The YAML example uses the shortened configuration syntax, which has not been presented yet (it's in section 4).
2.2. Mapping Configuration
Doctrine DBAL Configuration
This section should come before the previous one, as per my comment in section 1.
Shortened Configuration Syntax
This is orm-related, therefore should be a subsection of 2.
Custom Mapping Entities in a Bundle
This is orm related, therefore should be a subsection of 2
Mapping Entities Outside of a Bundle
This is orm related, therefore should be a subsection of 2
This PR reorders the sections this way:
2.1. Shortened Configuration Syntax
2.2. Caching Drivers
2.3. Mapping Configuration
2.4. Custom Mapping Entities in a Bundle
2.5. Mapping Entities Outside of a Bundle