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

[docs] Bite the bullet and go for v1-beta #9706

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 2, 2018
Copy link
Member

@kgregory kgregory left a comment

Choose a reason for hiding this comment

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

Awesome

README.md Outdated
> Should I start with v1-beta? But beta is a beta, so it's not a final product and I'm not guaranteed anything.

People are starting projects with v0.x which given the quality and stability of v1 they shouldn't be. The v1-beta effort started in May 2016.
There are lots of us using v1-beta in production already with no problems and the odd breaking change is less hassle than upgrading from v0.x to v1-beta.
Copy link
Member

Choose a reason for hiding this comment

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

I'd suggest changing:

There are lots of us using v1-beta in production already with no problems and the odd breaking change is less hassle than upgrading from v0.x to v1-beta.

To:

Many of us are already using v1-beta in production with no problems and resolving the occasional breaking change is less of a hassle than upgrading from v0.x to v1-beta.

Copy link
Member

Choose a reason for hiding this comment

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

"Less hassle" is also gramatically correct - and less words. 😄 I agree with the rest of your suggestion.

README.md Outdated
> Should I start with v1-beta? But beta is a beta, so it's not a final product and I'm not guaranteed anything.

People are starting projects with v0.x which given the quality and stability of v1 they shouldn't be. The v1-beta effort started in May 2016.
There are lots of us using v1-beta in production already with no problems and the odd breaking change is less hassle than upgrading from v0.x to v1-beta.
Copy link
Member

Choose a reason for hiding this comment

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

"Less hassle" is also gramatically correct - and less words. 😄 I agree with the rest of your suggestion.

README.md Outdated

Yes, you should. We often get this question:

> Should I start with v1-beta? But beta is a beta, so it's not a final product and I'm not guaranteed anything.
Copy link
Member

Choose a reason for hiding this comment

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

You could lose the "But".

README.md Outdated

> Should I start with v1-beta? But beta is a beta, so it's not a final product and I'm not guaranteed anything.

People are starting projects with v0.x which given the quality and stability of v1 they shouldn't be. The v1-beta effort started in May 2016.
Copy link
Member

Choose a reason for hiding this comment

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

"Some users are starting"

README.md Outdated

People are starting projects with v0.x which given the quality and stability of v1 they shouldn't be. The v1-beta effort started in May 2016.
There are lots of us using v1-beta in production already with no problems and the odd breaking change is less hassle than upgrading from v0.x to v1-beta.
They are just creating extra work for themselves as they will have to transition at some point.
Copy link
Member

Choose a reason for hiding this comment

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

This sentence needs to go before "There are lots of us" (or the @kgregory's suggested change.

README.md Outdated
There are lots of us using v1-beta in production already with no problems and the odd breaking change is less hassle than upgrading from v0.x to v1-beta.
They are just creating extra work for themselves as they will have to transition at some point.

Material-UI will never be a final product, you will never be guaranteed anything neither with v0.x nor v1, v2, etc.
Copy link
Member

Choose a reason for hiding this comment

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

"whether with v0.x, v1, or an future release."

Copy link
Member Author

Choose a reason for hiding this comment

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

Really?! Wow, I didn't know an future was English.

Copy link
Member

Choose a reason for hiding this comment

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

That's a new one for me as well.

Copy link
Member

Choose a reason for hiding this comment

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

Bah, "any", sorry. Typos in suggested changes are not good! 😦

Copy link
Member Author

Choose a reason for hiding this comment

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

Ohhh

Copy link
Member Author

Choose a reason for hiding this comment

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

@mbrookes Do you mind directly committing on v1-beta? :)

Copy link
Member

Choose a reason for hiding this comment

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

Will do.

@oliviertassinari oliviertassinari force-pushed the readme-use-v1-beta-over-master branch from b956b6c to 8ec94b5 Compare January 2, 2018 17:15
@oliviertassinari oliviertassinari dismissed stale reviews from kgregory and mbrookes January 2, 2018 17:16

done

Copy link
Member

@kgregory kgregory left a comment

Choose a reason for hiding this comment

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

great job

@oliviertassinari oliviertassinari merged commit 72fb3eb into mui:v1-beta Jan 3, 2018
@oliviertassinari oliviertassinari deleted the readme-use-v1-beta-over-master branch January 3, 2018 09:14
@eyn
Copy link
Contributor

eyn commented Jan 3, 2018

@oliviertassinari @kgregory @mbrookes - should we add a warning to http://www.material-ui.com/#/get-started pages so we make sure anyone looking at the project for the first time is pointed towards the beta?

@mbrookes
Copy link
Member

mbrookes commented Jan 4, 2018

@eyn Only just say your comment, but: #9727

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants