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

Use gitbook for docs #941

Merged
merged 8 commits into from Mar 17, 2016

Conversation

Projects
None yet
1 participant
@ssalinas
Member

ssalinas commented Mar 11, 2016

Reorganizing docs and displaying using gitbook. Eventual goal is be able to replace our github pages page with gitbook generated site.

ToDo:

  • Setup page with details for each release (like we have for 0.4.9 on the wiki). Fill out relevant details back to at least 0.4.5
  • Write more examples and docs for use of specific features, organize these in a folder so they can be pulled in in other locations by the gitbook
  • Update the ui page with more recent screenshots
  • Double check examples page and update to use an org repo
  • One more pass over all docs to be sure everything is up to date (examples are working, etc)

if you want to view the current state of the docs, on this branch you can npm install -g gitbook and run gitbook serve. Docs should be available on localhost:4000

@ssalinas ssalinas changed the title from (WIP) use gitbook for docs to Use gitbook for docs Mar 14, 2016

@ssalinas

This comment has been minimized.

Show comment
Hide comment
@ssalinas

ssalinas Mar 14, 2016

Member

Good draft of this is done now, with a bunch of docs added for a few features, releases, updated ui images, etc. Let me know what you think

also thanks @zdhickman for reading it over and fixing small stuff I missed ;)

Member

ssalinas commented Mar 14, 2016

Good draft of this is done now, with a bunch of docs added for a few features, releases, updated ui images, etc. Let me know what you think

also thanks @zdhickman for reading it over and fixing small stuff I missed ;)

@ssalinas

This comment has been minimized.

Show comment
Hide comment
@ssalinas

ssalinas Mar 17, 2016

Member

Some notes on this:

  • Changes to existing docs are just typo fixes, updating links, and a small bit of rewording. Most changes to the actual docs are additions of new docs
  • Created an intro.md which the gitbook uses at its landing page. This is almost the same as the README.md, but I wanted to have the flexibility of the gitbook homepage and README being different
  • Added a script that will build the latests swagger docs and split them up for the gitbook, build the gitbook, replace the favicon, and publish to gh-pages branch so that it is easy to update. This should only include the relevant files since the .bookignore excludes the actual source code
Member

ssalinas commented Mar 17, 2016

Some notes on this:

  • Changes to existing docs are just typo fixes, updating links, and a small bit of rewording. Most changes to the actual docs are additions of new docs
  • Created an intro.md which the gitbook uses at its landing page. This is almost the same as the README.md, but I wanted to have the flexibility of the gitbook homepage and README being different
  • Added a script that will build the latests swagger docs and split them up for the gitbook, build the gitbook, replace the favicon, and publish to gh-pages branch so that it is easy to update. This should only include the relevant files since the .bookignore excludes the actual source code

ssalinas added a commit that referenced this pull request Mar 17, 2016

@ssalinas ssalinas merged commit 58dd001 into master Mar 17, 2016

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details

@ssalinas ssalinas deleted the gitbook branch Mar 17, 2016

@ssalinas ssalinas modified the milestone: 0.4.12 Apr 1, 2016

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