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

Update docusaurus #1638

Merged
merged 13 commits into from Oct 14, 2020
Merged

Update docusaurus #1638

merged 13 commits into from Oct 14, 2020

Conversation

@netlify
Copy link

netlify bot commented Oct 6, 2020

Deploy preview for react-redux-docs ready!

Built with commit 80ccd27

https://deploy-preview-1638--react-redux-docs.netlify.app

@timdorr
Copy link
Member

timdorr commented Oct 6, 2020

Hmm, do we want to upgrade to 2.0? Everything appears A-OK, but we would be using the legacy theme.

@markerikson
Copy link
Contributor

Yes, I definitely want us to upgrade to DS v2! Just a question of whether the upgrade correctly handles all the versioning aspects we're using from v1 or not.

@markerikson
Copy link
Contributor

Hmm. This PR only seems to bump the DS version. Based on the work upgrading the Redux core docs from DSv1 to v2, I would expect this also requires a number of changes to the Docusaurus config files as well.

@josephMG , can you review the Docusaurus config files from https://github.com/reduxjs/redux/tree/master/website and https://github.com/reduxjs/redux-toolkit/tree/master/website and see what config changes need to be applied here as well? I assume that docusaurus.config.js, sidebars.js, and the src/css/custom.css files would need to be updated, at a minimum - possibly others too.

@josephMG
Copy link
Contributor Author

josephMG commented Oct 6, 2020

Yes I only upgrade version to DSv2. I think it still run DSv1 because I only modify docusaurus-1.x in Docusaurus package.

@markerikson Let me try it. I'm glad to help the rest of things to DSv2.

@markerikson
Copy link
Contributor

@josephMG hey, this is looking great so far! The PR preview is definitely using DS v2 now, and it looks like the versioning is (hopefully?) cooperating.

Will need to get the theme colors updated to match the other sites, and both the RTK and Redux core docs have a bunch of extra custom CSS that I'd like to pull over. Loving where this is going, and thank you!

@josephMG
Copy link
Contributor Author

josephMG commented Oct 13, 2020

@markerikson I fixed styles to match both the RTK and Redux. Btw, please notice these two things:

  1. The DSv2-alpha-65 version has only versions dropdown but not /versions link. I think DSv2-alpha-66 will handle it.
  2. In package.json I set --out-dir to build, because DSv2 no longer has react-redux in output build dir. The --out-dir can be removed if netlify command cd website; npm install; npm run build; cp _redirects ./build/react-redux/ changed.

@markerikson
Copy link
Contributor

markerikson commented Oct 13, 2020

Great! It's looking fairly close. Only thing I really see atm is that the "features" section should have a white background, not var(--ifm-blockquote-color). Can you tweak that?

Also, we should be able to add a netlify.toml that specifies the build commands if we want and override whatever's in the Netlify control panel settings atm. (Yes, I have the ability to change those control panel settings, just saying that Netlify will prefer the config file if specified and that's something we can add here.)

@josephMG
Copy link
Contributor Author

@markerikson Yes, I fixed features section color.

@markerikson
Copy link
Contributor

Awright, this looks good enough for now. Let's merge it, and we can always fix any other issues later.

@josephMG, thank you for doing this! :)

webguru7 pushed a commit to webguru7/react-redux that referenced this pull request Dec 8, 2022
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.

Incorrect/dead links
3 participants