Inital setup of docusaurus #3165

sveinpg · 2018-10-07T18:52:45Z

Added inital setup of docusaurus.

Missing files in docs:

README.md
PATRONS.md
CHANGELOG.md

Docusaurus requires docs to be placed in /docs. Should we move these files?

Also, since docusaurus currently does not support nested sidebars, I moved Structuring Reducers one level up in the sidebar.

markerikson · 2018-10-07T21:37:30Z

Hmm. Well, we can't move the actual README, because that's gotta stay at the root of the repo. PATRONS could be moved, and tbh CHANGELOG is kinda pointless.

Tell you what. Let's not include PATRONS or CHANGELOG in the actual published docs. Leave the files there for historical purposes, but no point in publishing them.

For the README... do we even want the entire README as a docs page itself? I'm not sure we do. Perhaps we should have a cut-down version of it in the docs.

timdorr · 2018-10-08T13:59:40Z

website/siteConfig.js

+  */
+
+  // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
+  copyright: `Copyright © ${new Date().getFullYear()} Your Name or Your Company Name`,


Need to fill this in.

What do you want it to say? "Redux JS"?

That's nice. Fixed now.

timdorr · 2018-10-08T14:01:53Z

.gitignore

+
+website/translated_docs
+website/build/
+website/yarn.lock


Please don't use Yarn. We use npm here. Also, don't ignore the lock file generated.

sveinpg · 2018-10-08T14:21:45Z

netlify · 2018-10-08T14:30:14Z

Deploy preview for redux-docs ready!

Built with commit 89faca9

https://deploy-preview-3165--redux-docs.netlify.com

markerikson · 2018-10-08T18:48:32Z

Looks like Docusaurus just merged in the nested categories feature in facebook/docusaurus#892, and v1.4.1 should be out with that in the next few days.

timdorr

Sorry for the duplicate comments. There isn't a way to edit multiple files in a single commit from the web UI, so I'm just noting the places that are affected in the review UI for now.

timdorr · 2018-10-08T19:35:50Z

docs/introduction/CoreConcepts.md

+---
+id: core-consepts
+title: Core consepts
+sidebar_label: Core consepts


Spelling: "concepts"

timdorr · 2018-10-08T19:36:00Z

docs/recipes/reducers/PrerequisiteConcepts.md

+---
+id: prerequisite-consepts
+title: Prerequisite Consepts
+sidebar_label: Prerequisite Consepts


Spelling: "concepts"

timdorr · 2018-10-08T19:36:09Z

website/core/Footer.js

+          <div>
+            <h5>Docs</h5>
+            <a href={this.docUrl("introduction/core-consepts")}>
+              Core consepts


Spelling: "concepts"

timdorr · 2018-10-08T19:36:15Z

website/pages/en/index.js

+          <ProjectTitle />
+          <PromoSection>
+            <Button href={docUrl("introduction/core-consepts", language)}>
+              Core consepts


Spelling: "concepts"

timdorr · 2018-10-08T19:36:21Z

website/sidebars.json

+  "docs": {
+    "Introduction": [
+      "introduction/motivation",
+      "introduction/core-consepts",


Spelling: "concepts"

timdorr · 2018-10-08T19:36:26Z

website/sidebars.json

+    ],
+    "Structuring Reducers": [
+      "recipes/structuring-reducers",
+      "recipes/reducers/prerequisite-consepts",


Spelling: "concepts"

timdorr · 2018-10-08T19:36:31Z

website/siteConfig.js

+
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: "introduction/core-consepts", label: "Docs" },


Spelling: "concepts"

selbekk · 2018-10-09T06:08:38Z

What a great god damn effort @sveinpg 👏 👏 👏

timdorr · 2018-10-09T15:33:58Z

The only thing I don't like about this site so far: The sidebar position resets after navigating to a new page. If I'm way down at the API reference and click over from createStore to the Store, the sidebar is back at the top.

Also, for the "README", I'd like to see that be a "Getting Started" page that can replace the "Core Concepts" button on the front page. And that should contain just the bare minimum to make a store and dispatch actions. Simple and straightforward for those that don't want to read through many pages of docs 😄

endiliey · 2018-10-10T05:29:24Z

@timdorr

There is a workaround for the sidebar scroll position

facebook/docusaurus#823 (comment)

yangshun · 2018-10-12T06:31:04Z

@sveinpg Hi there, Docusaurus maintainer here. We managed to get the subcategories feature shipped in facebook/docusaurus#1026 and you should be able to keep the subcategories for "Structuring Reducers". Could you point your Docusaurus version to trunk for the moment? If there are things that Redux needs but Docusaurus doesn't support we could do it over the weekend. Else if all is good, I'll release Docusaurus 1.5.0 over the weekend which will include the subcategories feature.

Let me know what you think! We're here to support Redux's migration to Docusaurus 😄

sveinpg · 2018-10-12T18:29:51Z

@yangshun How do I point my docusaurus version to trunk?

yangshun · 2018-10-12T22:07:38Z

website/package.json

+    "rename-version": "docusaurus-rename-version"
+  },
+  "devDependencies": {
+    "docusaurus": "^1.4.0"


@sveinpg

Change this line to:

"docusaurus": "git://github.com/facebook/docusaurus.git#127500532103ee9096de9f202866546969ea107d"

Refer to https://stackoverflow.com/a/18049685/1751946 for more info.

yangshun · 2018-10-13T19:52:01Z

Docusaurus v1.5.0 has been released - https://github.com/facebook/Docusaurus/blob/master/CHANGELOG.md#150---2018-10-13

@sveinpg was trying out the trunk version yesterday and he showed me that the subcategories worked ok!

Thanks for your patience!

cc @markerikson @timdorr

markerikson · 2018-10-19T05:58:58Z

Okay, I just took a look at the current contents. It looks great!

I think this is more than sufficient to merge into the docs-rebuild branch, and we can open up some more issues to figure out what else actually needs to be done.

@sveinpg , thank you VERY much for some excellent work!

* Added metadata to the docs * Added initial docusaurus setup * Removed markdown block * Updated copyright * Removed yarn.lock from gitignore * Updated copyright * . * Add copyright to footer * Added white version of redux-icon to the header * Updated image urls to use https * Fixed spelling * Added script to scroll active sidebar in to viewport. * Moved content from README to a getting started section. * Replaced core concepts link with getting started * Updated docusaurus to 1.5.0 * Moved Structuring Reducers to a subcategory in the sidebar

sveinpg added 3 commits October 7, 2018 20:42

Added metadata to the docs

9fd9bd0

Added initial docusaurus setup

a4a2644

Removed markdown block

6179037

timdorr reviewed Oct 8, 2018

View reviewed changes

sveinpg and others added 4 commits October 8, 2018 16:13

Updated copyright

6c568a7

Removed yarn.lock from gitignore

802981b

Updated copyright

e271e17

.

f0a9869

reduxjs deleted a comment from netlify bot Oct 8, 2018

sveinpg added 3 commits October 8, 2018 21:06

Add copyright to footer

5378481

Added white version of redux-icon to the header

f739204

Updated image urls to use https

c3940f9

timdorr requested changes Oct 8, 2018

View reviewed changes

Fixed spelling

5df2faa

sveinpg added 3 commits October 10, 2018 10:29

Added script to scroll active sidebar in to viewport.

ff4890b

Moved content from README to a getting started section.

3afc4d2

Replaced core concepts link with getting started

c328fc6

yangshun reviewed Oct 12, 2018

View reviewed changes

sveinpg added 2 commits October 13, 2018 21:49

Updated docusaurus to 1.5.0

a595f83

Moved Structuring Reducers to a subcategory in the sidebar

89faca9

markerikson merged commit 944df4a into reduxjs:docs-rebuild Oct 19, 2018

markerikson mentioned this pull request Oct 19, 2018

Investigate alternative docs publishing solutions #3161

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inital setup of docusaurus #3165

Inital setup of docusaurus #3165

sveinpg commented Oct 7, 2018 •

edited

Loading

markerikson commented Oct 7, 2018

timdorr Oct 8, 2018

sveinpg Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

sveinpg Oct 8, 2018

timdorr Oct 8, 2018

sveinpg Oct 8, 2018

sveinpg commented Oct 8, 2018 •

edited

Loading

netlify bot commented Oct 8, 2018 •

edited

Loading

markerikson commented Oct 8, 2018

timdorr left a comment

timdorr Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

timdorr Oct 8, 2018

selbekk commented Oct 9, 2018

timdorr commented Oct 9, 2018

endiliey commented Oct 10, 2018

yangshun commented Oct 12, 2018

sveinpg commented Oct 12, 2018

yangshun Oct 12, 2018

yangshun commented Oct 13, 2018

markerikson commented Oct 19, 2018

Inital setup of docusaurus #3165

Inital setup of docusaurus #3165

Conversation

sveinpg commented Oct 7, 2018 • edited Loading

markerikson commented Oct 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sveinpg commented Oct 8, 2018 • edited Loading

netlify bot commented Oct 8, 2018 • edited Loading

markerikson commented Oct 8, 2018

timdorr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

selbekk commented Oct 9, 2018

timdorr commented Oct 9, 2018

endiliey commented Oct 10, 2018

yangshun commented Oct 12, 2018

sveinpg commented Oct 12, 2018

Choose a reason for hiding this comment

yangshun commented Oct 13, 2018

markerikson commented Oct 19, 2018

sveinpg commented Oct 7, 2018 •

edited

Loading

sveinpg commented Oct 8, 2018 •

edited

Loading

netlify bot commented Oct 8, 2018 •

edited

Loading