Skip to content

docs: update information about schematics #11091

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

Merged
merged 1 commit into from
May 2, 2018

Conversation

IgorMinar
Copy link
Contributor

I clarified some information to the best of my knowledge and restructured the doc a bit for better readability.

I clarified some information to the best of my knowledge and restructured the doc a bit for better readability.
@IgorMinar IgorMinar requested review from amcdnl and jelbourn as code owners May 1, 2018 16:13
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label May 1, 2018
@@ -6,22 +6,13 @@ Schematics come packaged with Angular Material, so once you have
installed the npm package, they will be available via the Angular CLI.

If you run it will automatically install Angular Material for you
and run the shell schematic.
and run the install schematic.
Copy link
Member

Choose a reason for hiding this comment

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

It is actually called "shell" in the collection.json. We should change that, too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"shell" typically means "app shell" which includes navigation similar to the material-nav schematic, but that is not included in the shell/install schematic as far as I know.

if you'd like to change the underlying schematic name, then could someone please take over this PR as I'm not familiar with the implementation details and won't have time to follow up on this PR today.

ng add @angular/material
```

## Generator Schematics
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know if "Generator Schematics" is the best term, but all the schematics are "packaged" so it seems like suboptimal name. I'd rather differentiate them by how they are used "install vs generator" than "shell vs packaged". please let me know if you think otherwise.

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM, the names are good now. I can change the name in a follow-up (we don't use the term "shell" for anything else so it won't be hard).

@jelbourn jelbourn added pr: lgtm docs This issue is related to documentation action: merge The PR is ready for merge by the caretaker and removed docs This issue is related to documentation labels May 1, 2018
@IgorMinar
Copy link
Contributor Author

thanks for the review!

@jelbourn jelbourn added the P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful label May 1, 2018
@jelbourn jelbourn added this to the 6.0 milestone May 1, 2018
@josephperrott josephperrott removed the request for review from amcdnl May 2, 2018 15:48
@josephperrott josephperrott merged commit 86ef891 into master May 2, 2018
@amcdnl amcdnl deleted the IgorMinar-docs/guide-schematics-update branch May 4, 2018 14:12
@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 8, 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 PR author has agreed to Google's Contributor License Agreement P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants