Skip to content

docs: Refactor-i18n-DOCS-758#36924

Closed
rockument69 wants to merge 1 commit intoangular:masterfrom
rockument69:rockument69-i18n-refactor
Closed

docs: Refactor-i18n-DOCS-758#36924
rockument69 wants to merge 1 commit intoangular:masterfrom
rockument69:rockument69-i18n-refactor

Conversation

@rockument69
Copy link
Copy Markdown
Contributor

Rewrite headings to focus on tasks and separate reference info and best practices from tasks. Add missing steps or procedures, and links to important information. Make the example open in StackBlitz. See i18n Documentation Plan at https://docs.google.com/document/d/1aV2TKsIqry7JnNiHEfhmheu5rNAbNl1IRYVhYErc7Ks/edit?usp=sharing

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?

As a page in Techniques, it should be task-oriented.
Headings focus on Angular features, not user tasks.
Some steps or procedures are missing.
Topic mixes tasks, best practices, and reference content.
Lack of linking with related topics.

Issue Number: DOCS-758

What is the new behavior?

Rewrote headings to focus on tasks and separated reference info and best practices from tasks. Added missing steps or procedures, and links to important information. Prepared the example to open in StackBlitz.

See i18n Documentation Plan

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@mary-poppins
Copy link
Copy Markdown

@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch 2 times, most recently from fe8eac8 to e7732c0 Compare May 6, 2020 23:23
@mary-poppins
Copy link
Copy Markdown

Comment thread aio/content/guide/i18n.md Outdated
@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from 87c71c4 to 36bc376 Compare May 7, 2020 20:13
@mary-poppins
Copy link
Copy Markdown

@ngbot ngbot Bot added this to the needsTriage milestone May 11, 2020
@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from 36bc376 to 4f11d99 Compare May 11, 2020 22:21
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from 9dc238b to 3172889 Compare May 13, 2020 21:02
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

Copy link
Copy Markdown
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

Reviewed up to the "Prepare templates for translations" section.

Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from b320fbe to 1bd68a3 Compare May 14, 2020 16:30
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
Copy link
Copy Markdown
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

I have reviewed up to the Prepare templates for translations section (exclusive). This reads much better and is accurate.

Should I continue to review further or wait?

@rockument69
Copy link
Copy Markdown
Contributor Author

rockument69 commented May 15, 2020

Should I continue to review further or wait?

@petebacondarwin:
Go ahead and review the rest of the guide. I have edited it to the end. I will address all of your suggestions and changes today and Monday. Thanks!

@rockument69 rockument69 self-assigned this May 15, 2020
@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from 2061560 to 98bc770 Compare May 15, 2020 16:36
@mary-poppins
Copy link
Copy Markdown

@rockument69 rockument69 force-pushed the rockument69-i18n-refactor branch from 9147b6d to e6bea7b Compare May 15, 2020 19:04
@rockument69
Copy link
Copy Markdown
Contributor Author

@petebacondarwin : All edits are done and commits squashed. This is the "finished draft" to review. I am also removing the WIP from the title. Thanks!

@rockument69 rockument69 changed the title [WIP] docs: Refactor-i18n-DOCS-758 docs: Refactor-i18n-DOCS-758 May 15, 2020
Comment thread aio/tools/examples/shared/boilerplate/i18n/angular.json Outdated
Comment thread aio/tools/examples/shared/boilerplate/i18n/package.json Outdated
Comment thread aio/tools/examples/shared/package.json Outdated
@petebacondarwin petebacondarwin force-pushed the rockument69-i18n-refactor branch from d1051c3 to 9278fff Compare June 17, 2020 17:06
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

@rockument69 rockument69 removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Jun 17, 2020
Copy link
Copy Markdown
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

Just a couple of last minute typos. Otherwise LGTM!
Thanks for you patience and diligence with this PR @rockument69

Comment thread aio/content/guide/i18n.md Outdated
Comment thread aio/content/guide/i18n.md Outdated
@petebacondarwin petebacondarwin added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jun 18, 2020
Copy link
Copy Markdown
Member

@clydin clydin left a comment

Choose a reason for hiding this comment

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

LGTM from a tooling perspective.

Rewrite headings to focus on tasks and separate reference info and best practices from tasks. Add missing steps or procedures, and links to important information. Make the example open in StackBlitz. See i18n Documentation Plan at https://docs.google.com/document/d/1aV2TKsIqry7JnNiHEfhmheu5rNAbNl1IRYVhYErc7Ks/edit?usp=sharing
@kapunahelewong kapunahelewong force-pushed the rockument69-i18n-refactor branch from 983cab4 to ebccd78 Compare June 18, 2020 18:37
@kapunahelewong kapunahelewong added action: review The PR is still awaiting reviews from at least one requested reviewer and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Jun 18, 2020
@mary-poppins
Copy link
Copy Markdown

@rockument69 rockument69 added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer state: needs doc team review labels Jun 22, 2020
This was linked to issues Jun 22, 2020
@rockument69 rockument69 mentioned this pull request Jun 22, 2020
@rockument69 rockument69 linked an issue Jun 22, 2020 that may be closed by this pull request
@mhevery mhevery closed this in 7e0eccc Jun 22, 2020
@angular-automatic-lock-bot
Copy link
Copy Markdown

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.

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

Labels

action: merge The PR is ready for merge by the caretaker cla: yes effort3: weeks risk: low target: patch This PR is targeted for the next patch release type: bug/fix

Projects

None yet

8 participants