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

blog: add a sneak-peek post about Docusaurus v2 #952

Merged
merged 16 commits into from
Sep 11, 2018

Conversation

endiliey
Copy link
Contributor

@endiliey endiliey commented Sep 9, 2018

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

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 9, 2018
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Sep 9, 2018

Deploy preview for docusaurus-preview ready!

Built with commit d99d144

https://deploy-preview-952--docusaurus-preview.netlify.com

@endiliey
Copy link
Contributor Author

endiliey commented Sep 9, 2018

We definitely need revision on the content 😭 / wording wise. Appreciate it if you guys could give some suggestion !! @yangshun @JoelMarcey

Copy link
Contributor

@yangshun yangshun left a 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?

@endiliey
Copy link
Contributor Author

Hmm.. i was thinking that maybe more details should be put in the actual Docusaurus 2 release post. This blog post aims to

  1. Point user to RFC issue
  2. Give an overview of planned v2
  3. Informing user that we are working on v2, so less features/ changes on v1

Wdyt ?

Is this good for you @JoelMarcey ?

@yangshun
Copy link
Contributor

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! 🎉

@endiliey
Copy link
Contributor Author

endiliey commented Sep 10, 2018

@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

@endiliey endiliey changed the title blog: add a blogpost talking about v2 plan & work blog: add a sneak-peek post about Docusaurus v2 Sep 10, 2018
@jaril
Copy link
Contributor

jaril commented Sep 10, 2018

Just two spelling improvements:

  • Howver, one thing that I'll highlight > However ...
  • Crowdin for translations,so >> translations, so ...
  • we do noot want to make Docusaurus better > we do not want ...

Other than those, it looks good! 👍

@yangshun yangshun merged commit 85f6c19 into facebook:master Sep 11, 2018
@yangshun
Copy link
Contributor

yangshun commented Sep 11, 2018

Merging this since @JoelMarcey has proofread it too 😄

@JoelMarcey
Copy link
Contributor

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:

"Docusaurus' mission has always been to make it really easy for you to get a website with documentation up and running out of the box. That mission does not change with Docusaurus 2."

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.

@yangshun
Copy link
Contributor

I'll add that line directly into master. Sorry about that!

@JoelMarcey
Copy link
Contributor

No problem. That's why we have easy to update posts 😄

@yangshun
Copy link
Contributor

Are there any other changes you want to make? If not I'll just add that line in.

@JoelMarcey
Copy link
Contributor

Not at this time -- I can make any further changes if I come up with any.

@endiliey endiliey deleted the blog-2.0 branch September 18, 2018 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants