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(aio): apply guidelines and update TOCs in ts-to-js #16054

Merged
merged 1 commit into from Apr 28, 2017

Conversation

kapunahelewong
Copy link
Contributor

@kapunahelewong kapunahelewong commented Apr 17, 2017

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (check one with "x")

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Other... Please describe: Copy edits to apply guidelines, make TOCs reflect doc shape, and clean up spaces added by migration tool.

What is the current behavior? (You can also link to an open issue here)

What is the new behavior?

Does this PR introduce a breaking change? (check one with "x")

[ ] Yes
[x] No

If this PR contains a breaking change, please describe the impact and migration path for existing applications: ...

Other information:

@kapunahelewong kapunahelewong changed the title docs(ts-to-js): apply guidelines and update TOCs [WIP] docs(ts-to-js): apply guidelines and update TOCs Apr 17, 2017
@mary-poppins
Copy link

The angular.io preview for b31dab8 is available here.

## AOT Compilation in _TypeScript_ only

Angular offers two modes of template compilation, JIT (_Just-in-Time_) and
[AOT (_Ahead-of-Time_)](guide/aot-compiler).
Angular offers two modes of template compilation, JIT (_just-in-time_) and
Copy link
Member

Choose a reason for hiding this comment

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

why lowercase? And wasn't it JiT and AoT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Foxandxss It was recently changed in the wordlist.

<div class="l-sub-section">



In the example above, there is no provider for the `'titlePrefix'` token.
Copy link
Member

Choose a reason for hiding this comment

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

can we indent this? Not sure if it is a good idea but I think so

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Foxandxss Sure - I just tried it and it worked. Last week it broke it to indent it. I like it indented better too.

EDIT: Another didn't work because there was a <script> tag in the copy that throws it. Have to keep the spacing on that one, but any other <div> should take indentation fine.

@mary-poppins
Copy link

The angular.io preview for 9e89c48 is available here.

@mary-poppins
Copy link

The angular.io preview for 6a6c121 is available here.

@petebacondarwin petebacondarwin added this to Content Only in docs-infra Apr 19, 2017
@kapunahelewong kapunahelewong force-pushed the wong-ts-to-js branch 2 times, most recently from bd2c9fb to 1d1b06a Compare April 19, 2017 15:48
@kapunahelewong kapunahelewong changed the title [WIP] docs(ts-to-js): apply guidelines and update TOCs [WIP] docs(aio): apply guidelines and update TOCs on ts-to-js Apr 19, 2017
@kapunahelewong kapunahelewong changed the title [WIP] docs(aio): apply guidelines and update TOCs on ts-to-js [WIP] docs(aio): apply guidelines and update TOCs in ts-to-js Apr 19, 2017
@kapunahelewong kapunahelewong changed the title [WIP] docs(aio): apply guidelines and update TOCs in ts-to-js docs(aio): apply guidelines and update TOCs in ts-to-js Apr 19, 2017
@mary-poppins
Copy link

The angular.io preview for 1d1b06a is available here.

@mary-poppins
Copy link

The angular.io preview for bd2c9fb is available here.

</code-tabs>



<div class="l-sub-section">
Copy link
Member

Choose a reason for hiding this comment

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

you need a blank line here for the next lines to be recognized as markdown rather than plain HTML

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

In the example above, there is no provider for the `'titlePrefix'` token.
Without `@Optional()`, Angular would raise an error.
With `@Optional()`, Angular sets the constructor parameter to `null`
and the component displays the title without a prefix.
Copy link
Member

Choose a reason for hiding this comment

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

and a blank line here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

<div class="l-sub-section">
_View_ children are associated with element tags that appear _within_ the component's template.
Copy link
Member

Choose a reason for hiding this comment

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

blank line before this line - and before the </div> below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

instead of the `@ViewChild` and `@ContentChild` property decorators.


In _TypeScript_ and _ES6-with-decorators_ you can also use the `queries` metadata
Copy link
Member

Choose a reason for hiding this comment

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

you get the idea :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, thank you for looking out! :)

Copy link
Member

@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.

if you have a block of HTML that should contain markdown then you need to separate the markdown from the HTML by blank lines.

@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 Apr 20, 2017
@mary-poppins
Copy link

The angular.io preview for c05efcf is available here.

@mary-poppins
Copy link

The angular.io preview for a145e73 is available here.

@wardbell wardbell removed the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Apr 28, 2017
@googlebot
Copy link

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

@wardbell
Copy link
Contributor

wardbell commented Apr 28, 2017

  • @kapunahelewong fixed the HTML problems noted by @petebacondarwin.
  • I fixed merge conflicts related to the relocation of the sample files.
  • Deleted manual TOC in favor of auto-generated TOC (which is our strong preference everywhere).
  • We both have signed the CLA.

This PR LGTM

@wardbell wardbell self-requested a review April 28, 2017 02:20
@wardbell wardbell added comp: docs action: merge The PR is ready for merge by the caretaker labels Apr 28, 2017
Copy link
Contributor

@wardbell wardbell left a comment

Choose a reason for hiding this comment

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

LGTM. This is a pure docs change the the Travis error is an unrelated flake. Merge away.

@mary-poppins
Copy link

The angular.io preview for 1749f04 is available here.

@mhevery
Copy link
Contributor

mhevery commented Apr 28, 2017

fix circle/ rebase

@googlebot
Copy link

CLAs look good, thanks!

@mary-poppins
Copy link

The angular.io preview for 8244bcf is available here.

@mary-poppins
Copy link

The angular.io preview for 0415112 is available here.

@mhevery mhevery merged commit b70b960 into angular:master Apr 28, 2017
@wardbell wardbell moved this from Content Only to MERGE in docs-infra May 1, 2017
@wardbell wardbell removed this from MERGE in docs-infra May 1, 2017
@kapunahelewong kapunahelewong deleted the wong-ts-to-js branch May 1, 2017 15:41
asnowwolf pushed a commit to asnowwolf/angular that referenced this pull request Aug 11, 2017
juleskremer pushed a commit to juleskremer/angular that referenced this pull request Aug 28, 2017
@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 Sep 11, 2019
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants