-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Investigate alternative docs publishing solutions #1031
Comments
I guess we need some sort of logo for react-redux aswell? |
Currently working on setting up docs publishing for React-Redux, per reduxjs/react-redux#1031 . Site is hosted at https://react-redux-docs.netlify.com/ . Semi-placeholder content for now (just the one page). We'll start publishing things for real as soon as we can figure out which site gen tool we're using. CNAME has been added at https://github.com/reduxjs/react-redux/blob/master/CNAME , and we're good with the terms and conditions.
Eh, logos can be handled separately :) I just hand-published the "Getting Started" docs page, which is now viewable at https://react-redux-docs.netlify.com/ . I've gone ahead and made the PR requesting https://react-redux.js.org based on that. |
I'll use the redux logo for now and create an initial setup of Docusaurus |
* #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
And we've got the initial Docusaurus setup merged in #1031 , and I've updated the Netlify settings to build and deploy that. We are LIVE at https://react-redux-docs.netlify.com ! Meanwhile, still waiting on the domain name PR to get merged . |
Aaaand the DNS request just got merged! https://react-redux.js.org/ |
Okay, I think we're going to go with Docusaurus at this point unless someone A) throws together a Gatsby (or other) example, and B) shows it works better. I'd like to see some experimentation with CodeSandbox embeds next. |
Also, I've turned on both Netlify deploy previews for PRs, and (hopefully) a bot that will add the preview link in a comment for visibility. |
* 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
…bar (reduxjs#1034) Added missing markdown document to sidebar and updated it's structure.
Pasting original discussion in reduxjs/redux#3161:
Since I'm suggesting we start with React-Redux, here's a separate issue to track that.
I'm in the process of trying to get the
react-redux.js.org
domain name, which I'd like to point to Netlify. I've set up an initial Netlify hosting at https://react-redux-docs.netlify.com (looks likereact-redux.netlify.com
is already taken with a broken app of some kind).I guess the first step is to get some kind of actual published content up so that I can justify the
.js.org
domain name request.The text was updated successfully, but these errors were encountered: