Skip to content

feat(i18n): extract keys from onboarding tour#17709

Merged
max-datahub merged 2 commits into
masterfrom
i18n/extract-onboarding
Jun 4, 2026
Merged

feat(i18n): extract keys from onboarding tour#17709
max-datahub merged 2 commits into
masterfrom
i18n/extract-onboarding

Conversation

@max-datahub
Copy link
Copy Markdown
Collaborator

Summary

Extracts hardcoded strings from the onboarding product-tour configs and modals into a new onboarding react-i18next namespace.

  • New en/onboarding.json (171 keys) grouped by tour/page: home, search, entityProfile (+ entityProfileV2), glossary, domains, users, groups, roles, policies, ingestion, lineageGraph, welcome (modal), tour. Rich step content (paragraphs with <strong>, "Learn more … here" links, bullet lists, keyboard-shortcut hints) uses <Trans> with bold/anchor slots; 10 keys are shared across the V1/V2 HomePage & EntityProfile configs.
  • No refactor: the config step arrays stay module-scope consts and use <Trans> (which defers translation to render), so OnboardingConfig/utils.tsx and their 10+ consumers are untouched. WelcomeToDataHubModal and OnboardingTour are real components and use useTranslation('onboarding').
  • Reuses common.feedback.loading and common.labels.owners/tags/columns0 new common keys.
  • Registers the namespace in i18n.ts + setupTests.ts; tracks the dir in translated-files.txt.
  • Normalizes source copy: &apos;', DatahubDataHub, standarizedstandardized, and a "Lineage have""Lineage has" grammar fix.

EN-only; German translation follows in a separate PR.

Pages to verify

The tour is triggered on first visit to each area (or any time via Cmd + Ctrl + T). With a non-English locale, trigger the tour and check the rich content renders/fits:

  • Home — Welcome modal + ingestion / domains / platforms / most-popular / search-bar steps (V1 and V2 home)
  • Entity profile — entities / properties / documentation / lineage / schema tab steps + owners / tags / glossary-terms / domain sidebar steps (V1 and V2)
  • Search results — filters / advanced / browse / "filters moved" steps
  • Business Glossary, Domains, Users, Groups, Roles, Policies, Ingestion, Lineage graph — each page's tour steps (incl. the "Learn more … here" doc links)
  • Welcome to DataHub modal — 5 carousel slides + "Get started"

Checklist

  • PR title follows Conventional Commits
  • tsc --noEmit, ESLint, Prettier, and Vitest (19/19) pass locally
  • Docs added/updated (n/a — UI string extraction)
  • Breaking changes (none)

🤖 Generated with Claude Code

Extract hardcoded strings from the onboarding product-tour configs and
modals into a new `onboarding` react-i18next namespace.

- Add en/onboarding.json (171 keys) grouped by tour/page (home, search,
  entityProfile, glossary, domains, users, groups, roles, policies,
  ingestion, lineageGraph, welcome, tour); rich step content uses <Trans>
- Config step arrays stay module-scope consts using <Trans> (renders
  lazily), so no hook refactor and no change to OnboardingConfig/utils
  consumers; WelcomeToDataHubModal and OnboardingTour use useTranslation
- Reuse common.feedback.loading and common.labels.owners/tags/columns
- Register in i18n.ts + setupTests.ts; track the dir in translated-files.txt
- Normalize source copy: &apos; to apostrophe, Datahub to DataHub, fix
  "standarized" and a "Lineage have"/"has" grammar slip

EN-only; German translation follows separately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the product PR or Issue related to the DataHub UI/UX label Jun 3, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 3, 2026

Bundle Report

Changes will increase total bundle size by 15.78kB (0.07%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
datahub-react-web-esm 23.42MB 15.78kB (0.07%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: datahub-react-web-esm

Assets Changed:

Asset Name Size Change Total Size Change (%)
assets/index-*.js -1.83kB 8.82MB -0.02%
assets/en-*.js 17.61kB 147.44kB 13.56% ⚠️

Files in assets/index-*.js:

  • ./src/app/onboarding/WelcomeToDataHubModal.tsx → Total Size: 9.29kB

  • ./src/app/onboarding/config/EntityProfileOnboardingConfig.tsx → Total Size: 10.03kB

  • ./src/app/onboarding/config/HomePageOnboardingConfig.tsx → Total Size: 5.82kB

  • ./src/app/onboarding/config/PoliciesOnboardingConfig.tsx → Total Size: 2.15kB

  • ./src/app/onboarding/config/DomainsOnboardingConfig.tsx → Total Size: 1.87kB

  • ./src/app/onboarding/OnboardingTour.tsx → Total Size: 4.13kB

  • ./src/app/onboarding/configV2/EntityProfileOnboardingConfig.tsx → Total Size: 9.46kB

  • ./src/i18n/i18n.ts → Total Size: 8.31kB

  • ./src/app/onboarding/WelcomeToDataHubModal.components.tsx → Total Size: 3.06kB

  • ./src/app/onboarding/config/IngestionOnboardingConfig.tsx → Total Size: 1.77kB

  • ./src/app/onboarding/config/RolesOnboardingConfig.tsx → Total Size: 1.55kB

  • ./src/app/onboarding/config/GroupsOnboardingConfig.tsx → Total Size: 2.11kB

  • ./src/app/onboarding/configV2/HomePageOnboardingConfig.tsx → Total Size: 6.95kB

  • ./src/app/onboarding/config/LineageGraphOnboardingConfig.tsx → Total Size: 1.91kB

  • ./src/app/onboarding/config/BusinessGlossaryOnboardingConfig.tsx → Total Size: 3.38kB

  • ./src/app/onboarding/config/SearchOnboardingConfig.tsx → Total Size: 2.14kB

  • ./src/app/onboarding/config/UsersOnboardingConfig.tsx → Total Size: 4.06kB

Files in assets/en-*.js:

  • ./src/i18n/locales/en/onboarding.json → Total Size: 18.15kB

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 3, 2026

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
datahub-web-react/src/i18n/i18n.ts 0.00% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Resolve translated-files.txt: keep onboarding glob (this PR) and auth glob
(master, from #17711).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@max-datahub max-datahub merged commit a08d123 into master Jun 4, 2026
53 of 54 checks passed
@max-datahub max-datahub deleted the i18n/extract-onboarding branch June 4, 2026 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-submitter-merge product PR or Issue related to the DataHub UI/UX

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants