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

config/config.example.yml: fix example syntax #2457

Merged
merged 1 commit into from
Sep 5, 2023

Conversation

alanorth
Copy link
Contributor

@alanorth alanorth commented Aug 24, 2023

Description

As of DSpace Angular 7.2 the configuration syntax has changed from TypeScript to YAML, but the comments in the example configuration are still using TypeScript syntax.

Note: the User Interface Customization page on the DSpace 7 wiki shows YAML keys without quotes in most cases. I'm not sure if it's optional (especially the regex ones).

Checklist

  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using yarn lint
  • My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

As of DSpace Angular 7.2 the syntax has changed from TypeScript to
YAML.
@alanorth alanorth added quick win Pull request is small in size & should be easy to review and/or merge configuration port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release labels Aug 24, 2023
@alanorth alanorth requested a review from a user August 24, 2023 12:05
@tdonohue tdonohue self-requested a review August 24, 2023 15:45
Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks @alanorth ! This looks correct to me. You are correct that some of the examples still have a JSON-style syntax...and now those are updated to valid YAML

@tdonohue tdonohue merged commit 65a215e into DSpace:main Sep 5, 2023
10 checks passed
@dspace-bot
Copy link
Contributor

Successfully created backport PR for dspace-7_x:

@tdonohue tdonohue added this to the 8.0 milestone Sep 5, 2023
@tdonohue tdonohue removed the port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release label Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration quick win Pull request is small in size & should be easy to review and/or merge
Projects
No open projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants