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

Fix incorrect example in config.example.yml #3683

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

tdonohue
Copy link
Member

Description

As of 7.6.2 / 8.0, we now have an option to control Angular's inlineCriticalCss. This is incorrectly documented in our config.example.yml as being environment.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.ts

This 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

  • This 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.

@tdonohue tdonohue added configuration 1 APPROVAL pull request only requires a single approval to merge port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Nov 22, 2024
@tdonohue tdonohue added this to the 9.0 milestone Nov 22, 2024
@tdonohue
Copy link
Member Author

Merging immediately as this is a "documentation" fix & tests pass. Will auto-port to 8.x and 7.x as this same issue appears in both of those releases.

@tdonohue tdonohue merged commit 256d71c into DSpace:main Nov 22, 2024
11 checks passed
@dspace-bot
Copy link
Contributor

Backport failed for dspace-7_x, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dspace-7_x
git worktree add -d .worktree/backport-3683-to-dspace-7_x origin/dspace-7_x
cd .worktree/backport-3683-to-dspace-7_x
git switch --create backport-3683-to-dspace-7_x
git cherry-pick -x 138c007f28b643397660e32d16d8b82b44731807

@dspace-bot
Copy link
Contributor

Successfully created backport PR for dspace-8_x:

@tdonohue tdonohue deleted the config_fixes branch November 22, 2024 17:20
@tdonohue tdonohue removed port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 APPROVAL pull request only requires a single approval to merge configuration
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants