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

Set up a published docs site #48

Closed
markerikson opened this issue Dec 2, 2018 · 9 comments
Closed

Set up a published docs site #48

markerikson opened this issue Dec 2, 2018 · 9 comments

Comments

@markerikson
Copy link
Collaborator

@markerikson markerikson commented Dec 2, 2018

I'd like to set up an actual published docs site using Docusaurus.

First step would be to copy over the Docusaurus config that we're using with React-Redux: https://github.com/reduxjs/react-redux/tree/master/website .

I've set up a Netlify project to host this, and am working on getting redux-starter-kit.js.org as a domain name (see js-org/js.org#2571 ).

From there, we can extract the docs content from our current README and move those into separate pages.

Please leave a comment if you'd like to work on this!

@markerikson markerikson mentioned this issue Dec 2, 2018
2 of 2 tasks complete
@sag1v

This comment has been minimized.

Copy link
Contributor

@sag1v sag1v commented Dec 3, 2018

I'm up for it.
Where do you want to move it to until the domain is ready?

@markerikson

This comment has been minimized.

Copy link
Collaborator Author

@markerikson markerikson commented Dec 3, 2018

I've got a Netlify site up at https://redux-starter-kit-docs.netlify.com that will host it. Once the domain name is ready, I'll just point it at that site.

In theory, this should mostly just need:

  • Copy the existing website folder from React-Redux
  • Rename all references from "react-redux" to "redux-starter-kit"
  • Create a docs folder with some initial content
  • Modify website/sidebars.json to point to the initial file
@sag1v

This comment has been minimized.

Copy link
Contributor

@sag1v sag1v commented Dec 3, 2018

Just to be clear...

Copy the existing website folder from React-Redux
Create a docs folder with some initial content

You want to copy the website folder content to redux-starter-kit/website
and create the docs folder in redux-starter-kit/website right?

Modify website/sidebars.json to point to the initial file

The initial file would be the existing redux-starter-kit/website/build/redux-starter-kit/index.html ?

@markerikson

This comment has been minimized.

Copy link
Collaborator Author

@markerikson markerikson commented Dec 3, 2018

You want to copy the website folder content to redux-starter-kit/website and create the docs folder in redux-starter-kit/website right?

Yeah, copy-pasting the site config from React-Redux would be the easiest way to get started setting it up for this repo.

Since we don't have any current Markdown docs content for Docusaurus to build, we'll need to create a /docs/ folder and add an initial docs file there. It can probably just be a copy of most of the README for now.

The current redux-starter-kit/website/build/redux-starter-kit/index.html is a placeholder, just so I could say that the Netlify site has valid content when I filed the domain name request. We'll remove that as soon as we have a Docusaurus build system set up.

@sag1v

This comment has been minimized.

Copy link
Contributor

@sag1v sag1v commented Dec 3, 2018

Cool, let me know if i need to change things.
note that i copy the index.html from build to docs.

https://github.com/sag1v/redux-starter-kit

@markerikson

This comment has been minimized.

Copy link
Collaborator Author

@markerikson markerikson commented Dec 3, 2018

Per my comment, the branch will need to have the config files changed to replace all React-Redux references with the starter kit's name and repo, and the site contents need to get changed.

@sag1v

This comment has been minimized.

Copy link
Contributor

@sag1v sag1v commented Dec 3, 2018

Do you see any other references I've missed?

@markerikson

This comment has been minimized.

Copy link
Collaborator Author

@markerikson markerikson commented Dec 3, 2018

Yeah, several - left comments appropriately.

@markerikson

This comment has been minimized.

Copy link
Collaborator Author

@markerikson markerikson commented Dec 28, 2018

This is done, so closing the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.