Fix incorrect example in config.example.yml
#3683
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.
Description
As of 7.6.2 / 8.0, we now have an option to control Angular's
inlineCriticalCss
. This is incorrectly documented in ourconfig.example.yml
as beingenvironment.universal.inlineCriticalCss
.The correct config is
environment.ssr.inlineCriticalCss
as shown in https://github.com/DSpace/dspace-angular/blob/main/server.ts#L248 and https://github.com/DSpace/dspace-angular/blob/main/src/config/ssr-config.interface.tsThis small PR corrects the example in
config.example.yml
and cleans up a few other minor comments around the example configs in that file.Instructions for Reviewers
config.example.yml
is not used anywhere in our codebase. It's meant for documentation purposes & as a simple example. So, this small PR does not require testing.