Skip to content

Add i18n Support#80

Draft
HelgeCD wants to merge 1 commit intomainfrom
adding-i18n-support
Draft

Add i18n Support#80
HelgeCD wants to merge 1 commit intomainfrom
adding-i18n-support

Conversation

@HelgeCD
Copy link
Copy Markdown
Contributor

@HelgeCD HelgeCD commented Feb 26, 2026

Still a WIP branch.

Before starting any actual implementation I created an ADR based on some SAP internal discussions. Goal is to be able to gather some more feedback before actually starting defining the specification.

Adding the ADR to the repo was aligned with @Fannon. The goal is to be able to understand the design decisions long term and outside the scope of a single PR. Not sure if the current structure is ideal, but I think it is a good starting point.

Next Steps: Gather Feedback (~2 weeks) and refine specification afterwards.

@github-actions
Copy link
Copy Markdown

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://open-resource-discovery.github.io/pr-preview/specification/pr-80/

Built to branch main at 2026-02-26 07:53 UTC.
Preview will be ready when the GitHub Pages deployment is complete.


**Support-Oriented Properties:**
- Package: `supportInfo` - Primarily for support teams, not end-users
- Extensible objects: `extensible.description` - Technical information for developers
Copy link
Copy Markdown
Member

@swennemers swennemers Feb 27, 2026

Choose a reason for hiding this comment

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

Extensibility should in general move into the end user/key user = business user responsibility and this information is shown in BAH/catalogs, therefore, we should enable translation for this property as well. The information here is necessary for key users to understand, what they need to select in their translated key user extensibility tools.

Comment on lines +48 to +51
**Option 1A: Generic JSON Paths**
- Use JSON Pointer syntax (e.g., `"$.title"`, `"$.shortDescription"`) to target translatable properties
- More flexible but risks targeting technical fields like `$.version` or `$.ordId`
- Fragile to schema changes and requires deep ORD structure knowledge
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we move this to the rejected options?


**Recommendation**: For the initial implementation, focus on the core translatable properties and defer complex object translation to a future version.

## Consequences
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we specify the impact and expectations on aggregators and consumers?
Especially:

  • Are aggregators expected to return the i18n info embedded into the ord resources to consumers?
  • Are consumers able to query with a target language and get texts in the target language with a language fallback? (like browsers/UIs do it)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

do we have aggregements on implementing this with our main aggregators?

Copy link
Copy Markdown
Member

@swennemers swennemers left a comment

Choose a reason for hiding this comment

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

@HelgeCD @Fannon , I reviewed the proposal, I am fine with the direction. Please see my comments for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants