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

Inital setup of docusaurus #3165

Merged
merged 16 commits into from Oct 19, 2018

Conversation

@sveinpg
Copy link
Contributor

commented Oct 7, 2018

#3161

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

This comment has been minimized.

Copy link
Contributor

commented Oct 7, 2018

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.

*/

// 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`,

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Need to fill this in.

This comment has been minimized.

Copy link
@sveinpg

sveinpg Oct 8, 2018

Author Contributor

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

As per the license (which covers the existing docs), Copyright (c) 2015-present Dan Abramov.

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Actually, maybe we should get a little more specific. Dan doesn't own copyright for things he didn't contribute. Copyright (c) 2015-present Dan Abramov and the Redux documentation authors.

This comment has been minimized.

Copy link
@sveinpg

sveinpg Oct 8, 2018

Author Contributor

That's nice. Fixed now.

.gitignore Outdated

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

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

This comment has been minimized.

Copy link
@sveinpg

sveinpg Oct 8, 2018

Author Contributor

Noted

sveinpg and others added 4 commits Oct 8, 2018
.
@sveinpg

This comment has been minimized.

Copy link
Contributor Author

commented Oct 8, 2018

Should we create an issue to cover what needs to be done?

Needs to be done:

  • Initial setup of docusaurus
  • Remove blog feature
  • Remove sample content and pages
  • Update footer links
  • Add copyright to footer
  • Fix internal links (like TOC)
  • Create cut-down verison of the README
  • Create frontpage design (what should be included on the frontpage?)
  • Update readme to reference the new website.
  • Remove template README from /website(?)
  • Set up search
@netlify

This comment has been minimized.

Copy link

commented Oct 8, 2018

Deploy preview for redux-docs ready!

Built with commit 89faca9

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

@reduxjs reduxjs deleted a comment from netlify bot Oct 8, 2018

@markerikson

This comment has been minimized.

Copy link
Contributor

commented Oct 8, 2018

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.

sveinpg added 3 commits Oct 8, 2018
sveinpg
sveinpg
@timdorr
Copy link
Member

left a comment

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.

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"


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

This comment has been minimized.

Copy link
@timdorr

timdorr Oct 8, 2018

Member

Spelling: "concepts"

sveinpg
@selbekk

This comment has been minimized.

Copy link
Contributor

commented Oct 9, 2018

What a great god damn effort @sveinpg 👏 👏 👏

@timdorr

This comment has been minimized.

Copy link
Member

commented Oct 9, 2018

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

This comment has been minimized.

Copy link
Contributor

commented Oct 10, 2018

@timdorr

There is a workaround for the sidebar scroll position

facebook/docusaurus#823 (comment)

@yangshun

This comment has been minimized.

Copy link
Contributor

commented Oct 12, 2018

@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

This comment has been minimized.

Copy link
Contributor Author

commented Oct 12, 2018

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

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

This comment has been minimized.

Copy link
@yangshun

yangshun Oct 12, 2018

Contributor

@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

This comment has been minimized.

Copy link
Contributor

commented Oct 13, 2018

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!

unknown-1

Thanks for your patience!

cc @markerikson @timdorr

@markerikson

This comment has been minimized.

Copy link
Contributor

commented Oct 19, 2018

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!

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

24 of 27 checks passed

Header rules No header rules processed
Details
Pages changed 135 new files uploaded
Details
Redirect rules No redirect rules processed
Details
Mixed content No mixed content detected
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - examples/async/package.json (Redux) No manifest changes detected
security/snyk - examples/async/package.json (timdorr) No manifest changes detected
security/snyk - examples/counter/package.json (Redux) No manifest changes detected
security/snyk - examples/counter/package.json (timdorr) No manifest changes detected
security/snyk - examples/real-world/package.json (Redux) No manifest changes detected
security/snyk - examples/real-world/package.json (timdorr) No manifest changes detected
security/snyk - examples/shopping-cart/package.json (Redux) No manifest changes detected
security/snyk - examples/shopping-cart/package.json (timdorr) No manifest changes detected
security/snyk - examples/todomvc/package.json (Redux) No manifest changes detected
security/snyk - examples/todomvc/package.json (timdorr) No manifest changes detected
security/snyk - examples/todos-flow/package.json (Redux) No manifest changes detected
security/snyk - examples/todos-flow/package.json (timdorr) No manifest changes detected
security/snyk - examples/todos-with-undo/package.json (Redux) No manifest changes detected
security/snyk - examples/todos-with-undo/package.json (timdorr) No manifest changes detected
security/snyk - examples/todos/package.json (Redux) No manifest changes detected
security/snyk - examples/todos/package.json (timdorr) No manifest changes detected
security/snyk - examples/tree-view/package.json (Redux) No manifest changes detected
security/snyk - examples/tree-view/package.json (timdorr) No manifest changes detected
security/snyk - examples/universal/package.json (Redux) No manifest changes detected
security/snyk - examples/universal/package.json (timdorr) No manifest changes detected
security/snyk - package.json (Redux) No manifest changes detected
security/snyk - package.json (timdorr) No manifest changes detected
markerikson added a commit that referenced this pull request Dec 3, 2018
Inital setup of docusaurus (#3165)
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
6 participants
You can’t perform that action at this time.