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

Made the labels in edit relationships tab unique #3307

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

alexandrevryghem
Copy link
Member

Description

Currently, the relationship type labels are not unique and don't work well when the relationship type is not in the form is{Entity1}Of{Entity2}. This PR ensures they are unique by including the two entity types and the relationship type in the label.

Instructions for Reviewers

List of changes in this PR:

  • Changed the way the getRelationshipMessageKey works by always forming the labels in the form: relationships.${currentEntityType}.${relationshipType}.${relatedEntityType} (both entity types are required in order to support the use case from Entities relations with invalid associations shown #1387)
  • I mapped all the i18n values from the previous keys to the new keys to avoid breaking the relationship type labels in other languages
  • I also changed the duplicate Publication label on the OrgUnit's edit relationship tab to: Organisation Publications & Authored Publications

Guidance for how to test or review this PR:

  • Verify that all default keys are correctly translated (I only created translations for the ones defined in dspace/config/entities/relationship-types.xml)

Checklist

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • 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.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • 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.

And fixed it for all the languages 🍞
…8157_entity-label-fix_contribute-main

# Conflicts:
#	src/app/item-page/edit-item-page/item-relationships/edit-relationship-list/edit-relationship-list.component.ts
#	src/assets/i18n/ar.json5
#	src/assets/i18n/cs.json5
#	src/assets/i18n/en.json5
#	src/assets/i18n/pt-BR.json5
@alexandrevryghem alexandrevryghem added i18n / l10n Internationalisation and localisation, related to message catalogs component: configurable entities related to configurable entities labels Sep 6, 2024
@alexandrevryghem alexandrevryghem self-assigned this Sep 6, 2024
…8157_entity-label-fix_contribute-main

# Conflicts:
#	src/app/item-page/simple/item-types/publication/publication.component.html
#	src/app/item-page/simple/item-types/untyped-item/untyped-item.component.html
#	src/assets/i18n/ar.json5
Copy link

Hi @alexandrevryghem,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

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.

@alexandrevryghem : We gave this a quick group review in our Developer Meeting today. Overall, the logic here makes sense & I can understand how you'd want these i18n labels to be different for different pages/components.

The big challenge is that this touches a large number of i18n json5 files, so it's going to hit frequent merge conflicts. I think we'll need to find way to get this merge conflict free & test/merge rapidly for 9.0. I'd hesitate to backport this PR because it changes so many i18n labels, but it seems good for 9.0.

Overall, there were no objections to this approach & it makes sense. We just need to try to merge it quickly once this has merge conflicts resolved, as it will hit frequent merge conflicts.

@alexandrevryghem alexandrevryghem added this to the 9.0 milestone Jan 28, 2025
Copy link

Hi @alexandrevryghem,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: configurable entities related to configurable entities i18n / l10n Internationalisation and localisation, related to message catalogs merge conflict
Projects
Status: 👀 Under Review
Development

Successfully merging this pull request may close these issues.

2 participants