-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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
blog: add a sneak-peek post about Docusaurus v2 #952
Conversation
Deploy preview for docusaurus-preview ready! Built with commit d99d144 |
We definitely need revision on the content 😭 / wording wise. Appreciate it if you guys could give some suggestion !! @yangshun @JoelMarcey |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@endiliey Good work! I made some changes to the content but didn't change the structure much because it is already awesome. Do you think it would be necessary to talk about any backward incompatibility issues and any possible migration plan from 1 to 2?
Hmm.. i was thinking that maybe more details should be put in the actual Docusaurus 2 release post. This blog post aims to
Wdyt ? Is this good for you @JoelMarcey ? |
Ok! I was thinking just a line or two that says we're might be changing some APIs that may break backward compatibility (although observant users would have already guessed that since it's a major bump). Another thing we can do is to look at other popular open source projects, see what they posted in their new version sneak peek post and see what our post is missing. It looks good! 🎉 |
@yangshun added a 'frequently asked questions'. Please look at it once again. 👍 https://deploy-preview-952--docusaurus-preview.netlify.com/blog/2018/09/11/towards-docusaurus-2 |
Just two spelling improvements:
Other than those, it looks good! 👍 |
Merging this since @JoelMarcey has proofread it too 😄 |
I was going to do one final pass on this before merging, but that's ok. I do think we should edit the post to add something to the effect of:
Maybe it goes into the "Final Thoughts" section or something. I just want to make sure that anyone reading the post understands that we are still staying true to the overall goal of the project. |
I'll add that line directly into master. Sorry about that! |
No problem. That's why we have easy to update posts 😄 |
Are there any other changes you want to make? If not I'll just add that line in. |
Not at this time -- I can make any further changes if I come up with any. |
Motivation
Add a blog post talking about the plan & work for Docusaurus 2.0.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
https://deploy-preview-952--docusaurus-preview.netlify.com/blog/2018/09/11/towards-docusaurus-2