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.

Sign up for GitHub

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

Jump to bottom

Add developer-facing i18n documentation #4044

Open
seancolsen opened this issue Dec 2, 2024 · 0 comments
Open

Add developer-facing i18n documentation #4044

seancolsen opened this issue Dec 2, 2024 · 0 comments
Assignees
@pavish
Labels
beta: approved Temporary label to mark issues that are approved ready Ready for implementation restricted: maintainers Only maintainers can resolve this issue type: enhancement New feature or request work: documentation Improvements or additions to documentation
Milestone
v0.2.0 (beta rele...

Comments

@seancolsen
Copy link
Contributor

seancolsen commented Dec 2, 2024 •
edited
Loading

E.g.

  • basics on string translation, e.g. wrap full sentences in translations; don't concatenate translated text; don't assume text will always be the same CSS width, etc.
  • when to translate a string vs when to not translate a string, e.g. words like PostgreSQL role LOGIN property not being translated — and how to ignore linting errors for untranslated UI strings
  • how to run translations through Transifex (or cross-reference with release docs)
  • how/when to use RichText
  • how/when to use plurals
  • how to update existing UI strings and ensure the new strings get re-translated (as discussed on Matrix)
  • best practices for translating strings inside .ts files
  • how to purge our strings file of unused strings (if/when we have a means to do so)
  • how to provide hints to Transifex, e.g. "record" as a noun vs "record" as a verb.

Related
@seancolsen seancolsen added ready Ready for implementation restricted: maintainers Only maintainers can resolve this issue type: enhancement New feature or request work: documentation Improvements or additions to documentation labels Dec 2, 2024
@seancolsen seancolsen added this to the v0.2.0 (beta release) milestone Dec 2, 2024
This was referenced Dec 2, 2024
Open
Open
@kgodey kgodey added the beta: needs discussion Temporary label to mark issues that need discussion label Dec 11, 2024
@kgodey kgodey added beta: approved Temporary label to mark issues that are approved and removed beta: needs discussion Temporary label to mark issues that need discussion labels Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pavish pavish

Labels
beta: approved Temporary label to mark issues that are approved ready Ready for implementation restricted: maintainers Only maintainers can resolve this issue type: enhancement New feature or request work: documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.2.0 (beta release) - nice to haves
Development

No branches or pull requests
3 participants
@seancolsen @kgodey @pavish