Localization Improvements - Phase 1

[damen-dotcms]

Parent Issue

No response

User Story

Currently dotCMS supports multilingual sites, however we’re fairly loose out of the box and some of the things we do don’t follow modern best practices. As a result users can do multilingual correctly if they invest time into config, or they can do them less-correctly if they don’t. We need to make a few tweaks to ensure that dotCMS is easy to use correctly right out of the box, and shore up our default install to align with modern standards for SEO and localization conventions.

There will be an estimated 2-3 phases to this project.

Loosely planned...

1. Phase 1 - Adding Locales
2. Phase 2 - Adding Reports & Tools to Help Find Content Missing Translations & Beef Up Localization SEO
3. Phase 3 - Adding Support for Translation Management Services

Acceptance Criteria

Phase 1

• Create Upgrade Script to Convert Language Variables to Content Items
• Create New PrimeNG Datatable Component
• Rebuild List Languages Page
• Rebuild Add New Language Workflow
• Rebuild Edit Language Page
• Rebuild Edit Default Language Variables Page, using Content Items
• Update Starter Site to Use Locale for URL Path
• Update Starter to Have Sitemap for Each Locale
• Update Starter to Use HREFLANG Blocks
• Update Default Locale to be Work by Site
• Re-Translate Admin Tools

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

• Localization Improvements - Phase 1 | dotCMS Internal Documentation - Google Docs || https://docs.google.com/document/d/1bjEM89vkt8TUcKiNgbCY8BPYfpTg_AX3Sb-Brxvy5AA/edit

Legacy Files, no longer source of truth.

• Multilingual Improvements | dotCMS Product Ideation - Google Docs | https://docs.google.com/document/d/1mf1hS-VrRuqZzboCPQTH_7hSW3iU5J5sRhPwP-t4M7k/edit
• Design Notes for Localization Improvements (Phase 1) | Product Ideation - Google Docs | https://docs.google.com/document/d/1pcZeqJyDrouHNXSE6ahv2v2WTYEasS9So2Iu1APlxqM/edit

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

• Create Upgrade Script to Convert Language Variables to Locale Content Items #27703
• Create New PrimeNG Datatable Component #27702
• Create UX Designs for "Localization - Phase 1" #27594
• Rebuild List Locales Page #25604
• Rebuild Add New Locale Workflow #25605
• Rebuild Edit Locale Page #25606
• Register the new Locale Variable Upgrade Task as a DataTask #27978
• Write an endpoint to retrieve the data needed by the new LanguageVariables screen  #27979
• Replace all api calls that retrieve LanguageKey by the a new APIs that return LanguageVariable (Content)  #28251
• Locale Variable Delete Action should actually delete the piece of content not archive it.  #28397
• Locale Variable Saving Action should publish Content  #28396
• Update PP logic to add lang variables as content to bundles #28395
• Rebuild Edit Default Language Variables Page using Content Items #25607
• [Empty Starter] : The Language Variable Content Type is not visible from the Content portlet #25891
• Update Screens for Add Language to Bundle Workflow #25608

[wezell]

@damen-dotcms we need to add - make the PageAPI respect the new localized urls, e.g.

• /api/v1/page/json/en-us/destinations/costa-rica
• /api/v1/page/json/en/destinations/costa-rica
• /api/v1/page/json/destinations/costa-rica
• /api/v1/page/json/es/destinations/costa-rica

[john-thomas-dotcms]

Some of the issues included in the original epic were later determined to not be required for phase 1. These have been moved to other epics.

All issues for this issue are now complete.