Skip to content

Split developer localization info out of the translator page#543

Draft
Copilot wants to merge 2 commits intomasterfrom
copilot/split-developer-info-translators-page
Draft

Split developer localization info out of the translator page#543
Copilot wants to merge 2 commits intomasterfrom
copilot/split-developer-info-translators-page

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 25, 2026

translating-ui.md mixed translator guidance with developer implementation details. The translator page should focus solely on Weblate usage and translation workflow.

Changes

translating-ui.md — stripped to translator-relevant content only:

  • Weblate links and status widget
  • The three workflow paragraphs (testing translations, reporting untranslated strings, reporting string concatenation misuse)
  • Wikibase/Wikidata translation guidance
  • Cross-reference to the new developer page

developer-guide-to-localization.md (new) — developer-focused localization reference:

  • Translation format: JSON structure, parameterized values, plural forms
  • New section on languages with more than two plural forms using CLDR named keyword syntax:
    {{plural:$1|one=singular form|few=few form|many=many form|other=default form}}
    
  • Front-end development: adding strings, with expanded guidance explicitly prohibiting string concatenation and HTML/CSS layout-based sentence composition
  • Adding a new language: file locations, Weblate vs. manual, lang-settings-ui.html registration
  • Server-side localisation: .properties files and Java class generation

sidebars.js — adds developer-guide-to-localization to the "Contributing as a developer" sidebar section.

Original prompt

This section details on the original issue you should resolve

<issue_title>Split developer information out of translators page</issue_title>
<issue_description>Since we're focusing docs/technical-reference/translating-ui.md on translators, all information not related to that role should be moved out of that page into a new or existing page in the developer's section.

The only things which should remain are the links to and information on using Weblate and the following section:

The translation is best done with Weblate. Changes are pushed to OpenRefine's git repository and are included in the next release.

Run OpenRefine from the master branch and check whether translated words fit to the layout. Not all items can be translated word by word, especially into non-Ìndo-European languages.

If you see any text which remains in English even when you have checked all items, please create a bug report in the issue tracker so that the developers can fix it. Similarly report any cases where the developer's have used string concatenation or layout to compose multi-part strings, rather than using the localization facilities.

The developer info should have added some more guidance on not using string concatenation (or layout based equivalents) as well as how to add new languages which have more than two plural forms (ie singular/plural).

</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 25, 2026

Deploy Preview for openrefine-website ready!

Name Link
🔨 Latest commit 0446f82
🔍 Latest deploy log https://app.netlify.com/projects/openrefine-website/deploys/699f27657287ce0008e8fc23
😎 Deploy Preview https://deploy-preview-543--openrefine-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

…e-to-localization.md

Co-authored-by: tfmorris <82178+tfmorris@users.noreply.github.com>
Copilot AI changed the title [WIP] Split developer information out of translators page Split developer localization info out of the translator page Feb 25, 2026
Copilot AI requested a review from tfmorris February 25, 2026 16:47
Copy link
Copy Markdown
Member

@magdmartin magdmartin left a comment

Choose a reason for hiding this comment

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

This is an interesting use case for @copilot. As a project, do we want to rely more on AI-assisted tools to manage our documentation? If so, we may want to define some boundaries. For example, limiting AI-generated contributions to experienced contributors (e.g., committers) could help reduce low-quality or poorly reviewed output and avoid unnecessarily increasing reviewer workload.

[Run OpenRefine from the master branch](/docs/technical-reference/build-test-run) and check whether translated words fit to the layout. Not all items can be translated word by word, especially into non-Ìndo-European languages.

So the key `core-index/help` will render as `"Aide"` in French.
If you see any text which remains in English even when you have checked all items, please create a bug report in the issue tracker so that the developers can fix it. Similarly report any cases where the developers have used string concatenation or layout to compose multi-part strings, rather than using the localization facilities.
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.

Should we recommend to open the bug on the main Github bug tracker (https://github.com/OpenRefine/OpenRefine/issues/new?template=bug_report.md ) and then the team triage the right repo? This would be the case if the missing translation is on an extension.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Split developer information out of translators page

3 participants