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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

New documentation on the upcoming GitBook #2837

Merged
merged 5 commits into from Feb 16, 2018

Conversation

3 participants
@SamyPesse
Contributor

SamyPesse commented Feb 14, 2018

Next week, we'll introduced a new version of GitBook (https://beta.gitbook.com/) 馃帀 . This version brings a better reading experience (mobile and desktop), awesome search (powered by Algolia) and some cool new features.

I've run an initial import of the Redux docs in the new GitBook, you can checkout the output at:
https://redux.gitbook.io/docs/

It'd be awesome to get your feedback on this new version, and see if you're interested in switching the Redux documentation to this!

screen shot 2018-02-14 at 18 10 06

This version also includes some advanced features to analyse the quality of your documentation: a search dashboard and insights about the quality of your docs:

screen shot 2018-02-14 at 18 02 03

screen shot 2018-02-14 at 18 02 30

@timdorr

This comment has been minimized.

Member

timdorr commented Feb 14, 2018

Neat!

Since the CLI tool goes away, do the docs get built on your servers instead? We haven't set it up, but we've always wanted to have automatic docs builds in Travis. If we can make that happen, great!

@SamyPesse

This comment has been minimized.

Contributor

SamyPesse commented Feb 14, 2018

@timdorr Yes, you'll no longer have to run the CLI, the new GitBook will keep the website synced with your GitHub repository!

I can send you an invite (I'll need your email or ping me at samy@gitbook.com).

The next steps if you want to switch are:

  1. Merge this PR
  2. Use the invite to join the "Redux" organization on beta.gitbook.com
  3. Setup the GitBook project to use this repository as a GitHub source
  4. Add the redux.js.org domain to the GitBook project and update the redux.js.org DNS
@timdorr

This comment has been minimized.

Member

timdorr commented Feb 14, 2018

It's username@username.com. Thanks!

@timdorr

This comment has been minimized.

Member

timdorr commented Feb 16, 2018

Submitted a request to update the DNS: js-org/js.org#1774

Looks good to me. Let's do this!

@timdorr timdorr merged commit b307091 into reduxjs:master Feb 16, 2018

12 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
security/snyk - examples/async/package.json No dependency changes
Details
security/snyk - examples/counter/package.json No dependency changes
Details
security/snyk - examples/real-world/package.json No dependency changes
Details
security/snyk - examples/shopping-cart/package.json No dependency changes
Details
security/snyk - examples/todomvc/package.json No dependency changes
Details
security/snyk - examples/todos-flow/package.json No dependency changes
Details
security/snyk - examples/todos-with-undo/package.json No dependency changes
Details
security/snyk - examples/todos/package.json No dependency changes
Details
security/snyk - examples/tree-view/package.json No dependency changes
Details
security/snyk - examples/universal/package.json No dependency changes
Details
security/snyk - package.json No new issues
Details
@markerikson

This comment has been minimized.

Contributor

markerikson commented Feb 18, 2018

Not sure I realized we'd actually pulled the trigger and switched. At first glance, I see two things that are broken:

I'm not happy with these differences, and we need to figure out a way to resolve them ASAP.

@SamyPesse

This comment has been minimized.

Contributor

SamyPesse commented Feb 18, 2018

@markerikson

All of our pages have had URLs ending with .html so far.

GitBook automatically setups redirects for .html to the new urls, for example https://redux.js.org/faq/immutable-data.html redirects to https://redux.js.org/faq/immutable-data.

The issue come from the docs/ prefix in previous url. I've missed it in my previous PR. I've opened a PR to fix it: #2843

I'm really sorry about this :(

I had hand-written short anchor tags and TOCs for the FAQ pages.

We are going to release a fix for this, no action is needed on your side. I'll keep you updated ASAP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment