Skip to content

bug(github docs): mention @angular/cdk in material installation instructions #5552

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.

Sign up for GitHub

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

Jump to bottom
Closed
julianobrasil opened this issue Jul 6, 2017 · 6 comments · Fixed by #5555
Closed

bug(github docs): mention @angular/cdk in material installation instructions #5552

julianobrasil opened this issue Jul 6, 2017 · 6 comments · Fixed by #5555
Labels
docs This issue is related to documentation help wanted The team would appreciate a PR from the community to address this issue P4 A relatively minor issue that is not relevant to core functions

Comments

@julianobrasil
Copy link
Contributor

Bug, feature request, or proposal:

Bug

What is the expected behavior?

github first page should specify @angular/material depends on @angular/cdk

What is the current behavior?

The intallation instructions on github mentions the @angular/cdk dependency just for the latest builds part.

image
@benb7760 benb7760 mentioned this issue Jul 6, 2017
Closed
@willshowell willshowell mentioned this issue Jul 6, 2017
Closed
@julianobrasil julianobrasil mentioned this issue Jul 6, 2017
Merged
@jelbourn
Copy link
Member

jelbourn commented Jul 7, 2017

We should really just remove this section from the README and point to the getting started guide.

@jelbourn jelbourn added docs This issue is related to documentation help wanted The team would appreciate a PR from the community to address this issue P4 A relatively minor issue that is not relevant to core functions labels Jul 7, 2017
@julianobrasil
Copy link
Contributor Author

I think removing the installation part entirely and leaving the Getting Started part is sufficient. I'll just include the latest builds installation in the Getting Started part:

npm install --save angular/material2-builds angular/cdk-builds

@julianobrasil
Copy link
Contributor Author

@jelbourn, I built a PR with these modifications: #5555 (comment). Take a look to see whether it's good.

@alexbjorlig
Copy link

What about @angular/animations, is that not a required package as well?

mmalerba pushed a commit that referenced this issue Jul 7, 2017
@julianobrasil @mmalerba
fix(github docs): Includes @angular/cdk in installation instructions (#…
eedf36c 
…5555)

* includes @angular/cdk in github material installation instructions

* Mention the latest builds instructions

Add the latest builds instructions in the installation section (Step 1).

* Delete the installation section

The Getting Started section has all the information necessary to proceed with installations: #5552 (comment)
@julianobrasil
Copy link
Contributor Author

@dauledk, it was already in Getting Started page on github.

amcdnl pushed a commit to amcdnl/material2 that referenced this issue Jul 8, 2017
@julianobrasil @amcdnl
fix(github docs): Includes @angular/cdk in installation instructions (a…
1e0ae1a 
…ngular#5555)

* includes @angular/cdk in github material installation instructions

* Mention the latest builds instructions

Add the latest builds instructions in the installation section (Step 1).

* Delete the installation section

The Getting Started section has all the information necessary to proceed with installations: angular#5552 (comment)
@joshuadfranklin joshuadfranklin mentioned this issue Aug 11, 2017
Closed
@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 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
docs This issue is related to documentation help wanted The team would appreciate a PR from the community to address this issue P4 A relatively minor issue that is not relevant to core functions
Projects
None yet
Milestone
No milestone
4 participants
@jelbourn @devversion @alexbjorlig @julianobrasil