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

Better document vue/vuetify installation #297

Merged
merged 3 commits into from Jan 8, 2021
Merged

Better document vue/vuetify installation #297

merged 3 commits into from Jan 8, 2021

Conversation

subdavis
Copy link
Contributor

@subdavis subdavis commented Jan 5, 2021

Made both Vue and Vuetify peer dependencies.

Had to change the install guide to explicitly install vuetify, and realized I was just replicating Vuetify docs inline.

So I switched to recommending vue add vuetify as the install mechanism, since it does quite a lot of work that a user would otherwise have to guess from looking at the GWC package json and vue.config.js

This way, for the most common case of "fresh project", you get a more first-class vuetify experience rather than trying to replicate our config by hand.

jbeezley
jbeezley previously approved these changes Jan 5, 2021
@subdavis subdavis marked this pull request as draft January 5, 2021 15:27
zachmullen
zachmullen previously approved these changes Jan 5, 2021
@subdavis subdavis mentioned this pull request Jan 7, 2021
@subdavis subdavis dismissed stale reviews from zachmullen and jbeezley via 387540b January 7, 2021 18:41
@subdavis
Copy link
Contributor Author

subdavis commented Jan 7, 2021

The issue is installing vue/vuetify for running tests and building demo app.

Doing this is unsupported by yarn. After 4 years of debate, a maintainer has decided "you can do it with a plugin in yarn 2". There are weird packages to hack around it, but I don't feel good about using one.

The proper yarn 1.X solution would be either a) a monorepo or b) an entirely separate repo for the demo app, neither of which is appropriate for the level of effort involved.

I think my docs changes are still good.

PTAL.

@subdavis subdavis marked this pull request as ready for review January 7, 2021 19:41
@subdavis subdavis changed the title Vue and Vuetify as peer deps Better document vue/vuetify installation Jan 8, 2021
@subdavis
Copy link
Contributor Author

subdavis commented Jan 8, 2021

@zachmullen this is the last thing blocking the 3.0 chain of events. Mostly just because I want the NPM page to include these changes.

@subdavis subdavis merged commit 8ac45cd into master Jan 8, 2021
@subdavis subdavis deleted the peer-dep branch January 8, 2021 15:54
subdavis pushed a commit that referenced this pull request Jan 8, 2021
* peer dep

* Revert peer dep

* Wrong section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants