Skip to content

docs: i18n code snippets#43216

Closed
petebacondarwin wants to merge 11 commits into
angular:masterfrom
petebacondarwin:docs-i18n-code-snippets
Closed

docs: i18n code snippets#43216
petebacondarwin wants to merge 11 commits into
angular:masterfrom
petebacondarwin:docs-i18n-code-snippets

Conversation

@petebacondarwin
Copy link
Copy Markdown
Contributor

Fixes #43215

@google-cla google-cla Bot added the cla: yes label Aug 20, 2021
@petebacondarwin petebacondarwin added aio: preview state: WIP target: patch This PR is targeted for the next patch release and removed cla: yes labels Aug 20, 2021
@ngbot ngbot Bot modified the milestone: Backlog Aug 20, 2021
@google-cla google-cla Bot added the cla: yes label Aug 20, 2021
@google-cla
Copy link
Copy Markdown

google-cla Bot commented Aug 20, 2021

☹️ Sorry, but only Googlers may change the label cla: yes.

@ngbot ngbot Bot modified the milestone: Backlog Aug 20, 2021
@mary-poppins
Copy link
Copy Markdown

You can preview 44983ce at https://pr43216-44983ce.ngbuilds.io/.

@petebacondarwin petebacondarwin force-pushed the docs-i18n-code-snippets branch from 44983ce to 13b5093 Compare August 30, 2021 10:38
@mary-poppins
Copy link
Copy Markdown

You can preview 13b5093 at https://pr43216-13b5093.ngbuilds.io/.

@petebacondarwin petebacondarwin force-pushed the docs-i18n-code-snippets branch from 13b5093 to f60a8e7 Compare August 30, 2021 16:10
@mary-poppins
Copy link
Copy Markdown

You can preview f60a8e7 at https://pr43216-f60a8e7.ngbuilds.io/.

@petebacondarwin petebacondarwin force-pushed the docs-i18n-code-snippets branch from f60a8e7 to 5dd512d Compare August 30, 2021 17:21
@mary-poppins
Copy link
Copy Markdown

You can preview 5dd512d at https://pr43216-5dd512d.ngbuilds.io/.

@mary-poppins
Copy link
Copy Markdown

You can preview 70bdf1a at https://pr43216-70bdf1a.ngbuilds.io/.

@petebacondarwin petebacondarwin added action: review The PR is still awaiting reviews from at least one requested reviewer and removed state: WIP labels Aug 31, 2021
@petebacondarwin petebacondarwin marked this pull request as ready for review August 31, 2021 10:44
@petebacondarwin petebacondarwin force-pushed the docs-i18n-code-snippets branch from 70bdf1a to 10f7cb8 Compare August 31, 2021 16:39
@mary-poppins
Copy link
Copy Markdown

You can preview 10f7cb8 at https://pr43216-10f7cb8.ngbuilds.io/.

@petebacondarwin petebacondarwin force-pushed the docs-i18n-code-snippets branch from 10f7cb8 to 2a19278 Compare August 31, 2021 17:48
@mary-poppins
Copy link
Copy Markdown

You can preview 2a19278 at https://pr43216-2a19278.ngbuilds.io/.

Copy link
Copy Markdown
Contributor

@josmar-crwdstffng josmar-crwdstffng left a comment

Choose a reason for hiding this comment

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

The changes meet the requirements for my documentation request. Thank you.

AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
…nts (#43216)

Now JSON files should be commented using

```
// #docregion
```

rather than

```
/* #docregion */
```

There are currently no JSON files with either kind of comments so this change
has no impact yet.

But when we add some examples with such comments, they will also benefit
from `// ... ` style docplasters to join docregion fragments.

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
…egion (#43216)

This change makes docplaster markers fit better with the surrounding code
that is being rendered.  Instead of:

```
{
  "a": 100,
// ...
  "b": 200,
// ...
}
```

you can now get

```
{
  "a": 100,
  // ...
  "b": 200,
  // ...
}
```

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
 1�743216)

It is now possible to specify file paths in the `"boilerplate-override"`
property of `example-config.json` files to tell the example boilerplate
system to use the file in the example directory rather than overwriting the
example file with that from the boilerplate directory.

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
Note that because `angular.json` is a "boilerplate" file we cannot
just add comments to the one that is actually used in the application.

Instead this commit makes a copy, which is annotated with docregions.
To ensure that this file is not ignored by the example-collector, we had to
update the `.gitignore` to not ignore this file. (This also allows the file to be
easily stored tracked in git).

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
This commit tells the docregion parser how to process files that end in `.conf`.

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
…nts (#43216)

Now JSON files should be commented using

```
// #docregion
```

rather than

```
/* #docregion */
```

There are currently no JSON files with either kind of comments so this change
has no impact yet.

But when we add some examples with such comments, they will also benefit
from `// ... ` style docplasters to join docregion fragments.

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
…egion (#43216)

This change makes docplaster markers fit better with the surrounding code
that is being rendered.  Instead of:

```
{
  "a": 100,
// ...
  "b": 200,
// ...
}
```

you can now get

```
{
  "a": 100,
  // ...
  "b": 200,
  // ...
}
```

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
 1�743216)

It is now possible to specify file paths in the `"boilerplate-override"`
property of `example-config.json` files to tell the example boilerplate
system to use the file in the example directory rather than overwriting the
example file with that from the boilerplate directory.

PR Close #43216
AndrewKushnir pushed a commit that referenced this pull request Sep 15, 2021
Note that because `angular.json` is a "boilerplate" file we cannot
just add comments to the one that is actually used in the application.

Instead this commit makes a copy, which is annotated with docregions.
To ensure that this file is not ignored by the example-collector, we had to
update the `.gitignore` to not ignore this file. (This also allows the file to be
easily stored tracked in git).

PR Close #43216
@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 target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create code snippets

4 participants