#1031 Set up basic docusaurus structure #1032
Conversation
|
@markerikson Seems like some checks were not successful? Do you mind pointing me in the right direction? |
|
Looks like the Netlify integration I turned on this afternoon added a whole bunch of additional checks. Most of those checks are failing because it's not publishing the output to the folder I'd specified in Netlify, which was Out of curiosity what's the Dockerfile for in this setup? How does that fit in? I'd also prefer to keep our content in |
docusaurus/website/siteConfig.js
Outdated
|
|
||
| // Used for publishing and more | ||
| projectName: "react-redux", | ||
| organizationName: "facebook", |
There was a problem hiding this comment.
We're not Facebook :) We're the reduxjs org.
docusaurus/website/siteConfig.js
Outdated
| const siteConfig = { | ||
| title: "React Redux", // Title for your website. | ||
| tagline: "React Redux Documentation", | ||
| url: "https://your-docusaurus-test-site.com", // Your website URL |
There was a problem hiding this comment.
This should hopefully be https://react-redux.js.org shortly.
docusaurus/website/siteConfig.js
Outdated
|
|
||
| /* Colors for website */ | ||
| colors: { | ||
| primaryColor: "#20232a", |
There was a problem hiding this comment.
Seems like these are shades of blue? Let's try to go with Redux's purple and white, or something like that.
|
Now that I look at this, is there a reason to actually have this in a |
|
Babel's setup is a new repo for the docusaurus website and docs. Personally I prefer if the docs is in the repo itself. However, babel is a special case since it consists of multiple repos. We could move the |
|
The |
…d updated values in siteConfig.js according to comments by @markerikson
|
Okay, let's give this a shot. Can always revert it if things seem weird. I'll merge it now. I'll be busy this afternoon, but will try working on some of the setup for it tonight. |
|
Okay, this is pretty cool! I just pulled master locally, installed website deps, and ran the local server, and it works! We'll want to see how to get better syntax highlighting for the snippets, and also play around with how to get CodeSandbox embeds working, but this is a great start! Now, let me see about how to get this hooked up to Netlify... |
|
Great! Let me know if I can contribute on anything else. |
|
Tell you what. Can you go and investigate how Babel and React have a bot set up to do preview deploys of PRs? |
|
WOOHOO! We are LIVE!!! |
|
Sure. I'll take a look at it tomorrow |
|
@markerikson Seems like you can enable branch deploys to get the desired behaviour as described here: https://www.netlify.com/docs/continuous-deployment/#branches-deploys |
|
Okay, I think I just turned it on. Now, I see the deploy preview "check" for #1033 , but it's kinda buried in the "checks" section. Perhaps the bots are needed to add a comment pointing to that for visibility? |
|
There is a section om how to configure it called "github pull request comments" |
|
Yep, got that figured out and turned on! |
* reduxjs#1031 Set up basic docusaurus structure * Removed docker related files * Added metadata to the doc files * Code review: Moved docusaurus website to the top level of the repo and updated values in siteConfig.js according to comments by @markerikson
#1031. Initial setup of docusaurus in a separate folder (
/docusaurus).To run locally or publish you first have to change folders to
/docusaurus/websiteRun locally:
npm install && npm startThis should open the docusaurus on localhost:3000
To publish to netlify: https://docusaurus.io/docs/en/publishing#hosting-on-netlify