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

Migrate Docs to Docusaurus 2 Alpha #3584

Closed
aswathkk opened this issue Oct 13, 2019 · 17 comments
Closed

Migrate Docs to Docusaurus 2 Alpha #3584

aswathkk opened this issue Oct 13, 2019 · 17 comments
Labels

Comments

@aswathkk
Copy link

Hi there! The Docusaurus team is currently developing Docusaurus 2 and are almost done with an MVP that doesn't include translations and versioning features, which means there's feature parity with your website's current usage of Docusaurus.

Docusaurus 2 brings about many improvements:

  • Client-side rendering with prerendering (site renders without JavaScript!)
  • More flexible appearance - Customizable layouts, CSS modules, etc
  • Embeddable interactive React components within markdown via MDX

I will be your POC in helping you throughout the migration process. Let me know what you think!

cc @yangshun @endiliey

@markerikson
Copy link
Contributor

markerikson commented Oct 13, 2019

Hiya. How about we try switching the Redux Starter Kit docs first (https://github.com/reduxjs/redux-starter-kit)? The site is smaller, and also doesn't use versioning, so it'd be a simpler first step. (We also use Docusaurus for React-Redux, but that one uses versioning.)

Also, we're hoping to start revamping the Redux core docs content in the near future (see #3313 ). Would have to figure out how to manage working on that vs the Docusaurus update.

@yangshun
Copy link
Contributor

As far as I can tell, redux.js.org doesn't use versioning yet, which makes it a suitable candidate for the migration. But starting with Redux Starter Kit sounds good as well!

@timdorr timdorr changed the title Migration Website to Docusaurus 2 Alpha Migrate Docs to Docusaurus 2 Alpha Oct 13, 2019
@aswathkk
Copy link
Author

@markerikson That sounds good to me. I will work on upgrading redux-starter-kit docs first.
And if we're planning to revamp Redux core docs content in future, then this is the best time to upgrade Docusaurus I think. Because we will be setting up the base for the docs to build upon.

@markerikson
Copy link
Contributor

Yeah, I'm on board with updating the Redux docs site too, just figure it'll be easier to start with a smaller one first.

@timdorr
Copy link
Member

timdorr commented Oct 29, 2019

I'd say we hold off on alpha or beta quality for these higher-traffic docs. RSK would be a great candidate if you haven't already tried (sorry, I'm lazy and didn't check before posting this...).

@timdorr timdorr closed this as completed Oct 29, 2019
@markerikson
Copy link
Contributor

Agreed - we've got reduxjs/redux-toolkit#226 open, although I haven't been looking at it closely.

@markerikson
Copy link
Contributor

We've migrated RTK and I'm pretty happy with it. I'd like to reopen this and see if we can get the migration started.

@markerikson markerikson reopened this Nov 24, 2019
@markerikson
Copy link
Contributor

@aswathkk : are you interested in trying to start the migration efforts, or should we see if other folks in the community want to do that?

I figure we should be able to start by directly porting the current config from RTK, and determine what other tweaks are needed from there.

@smorimoto
Copy link
Contributor

Can I take this? I recently helped Infer's website migration.

@yangshun
Copy link
Contributor

@imbsky sure but could you ensure Infer's new website gets merged asap? So that you can focus on one website at a time 😄

@smorimoto
Copy link
Contributor

@yangshun Yeah, sure!

@smorimoto
Copy link
Contributor

Almost done.

@yangshun
Copy link
Contributor

Almost done with Redux website? No way... 😱

@smorimoto
Copy link
Contributor

smorimoto commented Nov 24, 2019

Still needs a lot of tweaking, but here is a preview.
https://build-c69e7nasw.now.sh

@aswathkk
Copy link
Author

@aswathkk : are you interested in trying to start the migration efforts, or should we see if other folks in the community want to do that?

I figure we should be able to start by directly porting the current config from RTK, and determine what other tweaks are needed from there.

@markerikson
Since @imbsky progressed a lot on this one, let them continue working on this.

@markerikson
Copy link
Contributor

markerikson commented Dec 20, 2019

Aaaaand we're LIVE!

https://redux.js.org

Thanks to all the folks who helped with this!

@yangshun
Copy link
Contributor

Omg finally! I'll go through the comments and see what follow up needs to be done on Docusaurus/Infima side.

Btw I think the URL should be redux.js.org (there's a typo)

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

No branches or pull requests

5 participants