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.

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

docs (docs-infra): i18n steps for subsequent changes #46471

Closed

Conversation

daniel-sc
Copy link

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Currently the documentation is missing a section on how to update translations for subsequent changes to an existing application.

Issue Number: N/A

What is the new behavior?

Added a section describing steps for text changes after the first i18n extraction.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@pullapprove pullapprove bot requested a review from dgp1130 June 23, 2022 09:27
@daniel-sc daniel-sc force-pushed the doc-i18n-subsequent-changes branch from 23733f3 to cb1c71e Compare June 23, 2022 09:59
@ngbot ngbot bot added this to the Backlog milestone Jun 27, 2022
@dylhunn dylhunn added the action: review The PR is still awaiting reviews from at least one requested reviewer label Jun 27, 2022
@dgp1130
Copy link
Contributor

dgp1130 commented Jun 27, 2022

Hi @daniel-sc, I think the previous section mentions repeating the process for new translations so I don't think we need a new section for this (admittedly the existing content could be a little clearer). We also don't typically recommend specific non-official tools on angular.io, and I don't think either of those should be necessary to work with translations (even if they might help). Is there a specific aspect of the i18n process where you were confused or struggling which we can improve in the docs here?

@daniel-sc
Copy link
Author

Hi @dgp1130 thanks for your feedback!

Disclosure: I'm the author of one of the referenced tools https://github.com/daniel-sc/ng-extract-i18n-merge (should have included this in the original description..)

I'll try to give some reasons, why I think the addition would add value to angular i18n users:

  1. As far as I can see there is no description for the process of updating an app with existing translations. (I think you referred to "7. Repeat the above steps for each language you want to add to your application.", which relates to adding new languages and not to updates?)
  2. Many users are confused how to update the translations and many blogs etc. reference the unmaintained tool https://github.com/martinroob/ngx-i18nsupport - by including this in the official documentation this confusion could be resolved. See e.g.

But of course it is your decision if this is the right place for this!

@dgp1130
Copy link
Contributor

dgp1130 commented Jun 30, 2022

Let's discuss more in angular/angular-cli#23428. If we need to modify documentation as part of that, we can revisit this suggestion.

@dgp1130 dgp1130 closed this Jun 30, 2022
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jul 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: review The PR is still awaiting reviews from at least one requested reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants