docs(aio): high-level documentation of AIO tooling#18151
docs(aio): high-level documentation of AIO tooling#18151petebacondarwin wants to merge 7 commits intoangular:masterfrom
Conversation
1c89bb6 to
31f1bed
Compare
|
You can preview 31f1bed at https://pr18151-31f1bed.ngbuilds.io/. |
|
You can preview 1c89bb6 at https://pr18151-1c89bb6.ngbuilds.io/. |
76d40e4 to
9281e95
Compare
|
You can preview 76d40e4 at https://pr18151-76d40e4.ngbuilds.io/. |
|
You can preview 9281e95 at https://pr18151-9281e95.ngbuilds.io/. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
It might be worth mentioning how zips can be built.
There was a problem hiding this comment.
It might be worth adding some info on how to use Plunkers in docs.
There was a problem hiding this comment.
Using them in docs should go in the authoring guide. These READMEs are for maintainers so more focussed on the code.
There was a problem hiding this comment.
OK then. I thought they were meant for people writing docs (authors, engs writing API docs).
There was a problem hiding this comment.
This section could be moved to the dedicated README.
There was a problem hiding this comment.
plunker-builder/README.md --> transforms/README.md
There was a problem hiding this comment.
stored in the aio/tools/transforms folder. See ... --> stored in this folder.
|
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 |
|
You can preview c9f96fa at https://pr18151-c9f96fa.ngbuilds.io/. |
|
You can preview d782637 at https://pr18151-d782637.ngbuilds.io/. |
d782637 to
9fb9a20
Compare
|
You can preview 9fb9a20 at https://pr18151-9fb9a20.ngbuilds.io/. |
gkalpak
left a comment
There was a problem hiding this comment.
Personal preference:
Limiting lines 100/120 chars even in markdown files, makes diffing/reviewing easier 😁
(Others might disagree.)
There was a problem hiding this comment.
Added a bit more of explanation. If it is still unclear, we can do better.
There was a problem hiding this comment.
Add a link to the "Plunker tool" docs.
|
You can preview e72c7bc at https://pr18151-e72c7bc.ngbuilds.io/. |
There was a problem hiding this comment.
This will be obsolete after #18290 (but may be worth leaving for future experimentations).
There was a problem hiding this comment.
Could also mention zipper.json.
|
I think we should land this stuff and then iterate. Otherwise it will get stale and no one will want to take it on. |
e72c7bc to
a1e0558
Compare
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
No description provided.