Skip to content

docs(aio): high-level documentation of AIO tooling#18151

Closed
petebacondarwin wants to merge 7 commits intoangular:masterfrom
petebacondarwin:aio-tooling-docs
Closed

docs(aio): high-level documentation of AIO tooling#18151
petebacondarwin wants to merge 7 commits intoangular:masterfrom
petebacondarwin:aio-tooling-docs

Conversation

@petebacondarwin
Copy link
Copy Markdown
Contributor

No description provided.

@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

@petebacondarwin petebacondarwin force-pushed the aio-tooling-docs branch 2 times, most recently from 76d40e4 to 9281e95 Compare July 15, 2017 16:31
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

Docs FTW 💯

Comment thread aio/tools/transforms/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Templates what?

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

@gkalpak gkalpak Jul 18, 2017

Choose a reason for hiding this comment

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

This section has actually more details than examples/README.md. I think it makes sense to move the exra details (e.g. utility files descriptions) to the README and add instructions/examples on how to actually use them.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Fixed.

Comment thread aio/tools/example-zipper/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It might be worth mentioning how zips can be built.

Comment thread aio/tools/plunker-builder/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It might be worth adding some info on how to use Plunkers in docs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Using them in docs should go in the authoring guide. These READMEs are for maintainers so more focussed on the code.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

OK then. I thought they were meant for people writing docs (authors, engs writing API docs).

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This section could be moved to the dedicated README.

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

plunker-builder/README.md --> transforms/README.md

Comment thread aio/tools/transforms/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

stored in the aio/tools/transforms folder. See ... --> stored in this folder.

@googlebot
Copy link
Copy Markdown

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.

@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

Personal preference:
Limiting lines 100/120 chars even in markdown files, makes diffing/reviewing easier 😁
(Others might disagree.)

Comment thread aio/tools/plunker-builder/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❤️

Comment thread aio/tools/example-zipper/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

kind --> kinds

Comment thread aio/tools/example-zipper/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

scripts tags --> scripts (?)

Comment thread aio/tools/example-zipper/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

system.js --> System.js 😁

Comment thread aio/tools/example-zipper/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

with with --> with

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

contains --> contain

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What are -builds versions?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Added a bit more of explanation. If it is still unclear, we can do better.

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

script tags --> scripts (?)

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add a link to the "Plunker tool" docs.

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What about zipper.json?

@mary-poppins
Copy link
Copy Markdown

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This will be obsolete after #18290 (but may be worth leaving for future experimentations).

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This file has been renamed.

Comment thread aio/tools/plunker-builder/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

a --> an

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/src/... --> src/... 😁

Comment thread aio/tools/examples/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could also mention zipper.json.

Comment thread aio/tools/README.md Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Fixed.

@petebacondarwin
Copy link
Copy Markdown
Contributor Author

I think we should land this stuff and then iterate. Otherwise it will get stale and no one will want to take it on.

@petebacondarwin petebacondarwin added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release and removed state: WIP labels Sep 21, 2017
@mary-poppins
Copy link
Copy Markdown

@mary-poppins
Copy link
Copy Markdown

IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
@IgorMinar IgorMinar closed this in 28a80e6 Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
IgorMinar pushed a commit that referenced this pull request Sep 21, 2017
@petebacondarwin petebacondarwin deleted the aio-tooling-docs branch September 21, 2017 20:42
@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.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Sep 12, 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 target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants