dolysis
/
rocksdb
mirror of https://github.com/facebook/rocksdb.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
rocksdb/docs
History
Joel Marcey 04b02dd121 Testing asset links after config change 2016-10-07 16:28:44 -07:00
..
_data Add author fields to blog posts 2016-10-04 14:11:04 -07:00
_docs Add FAQ based on the front page of the current rocksdb.org 2016-09-01 17:34:39 -07:00
_includes "Recent Posts" -> "All Posts" 2016-10-05 10:29:11 -07:00
_layouts CRLF -> LF mod (including removing trailing whitespace for those files) 2016-10-04 14:31:36 -07:00
_posts Forgot to truncate one blog post 2016-10-04 15:20:15 -07:00
_sass CRLF -> LF mod (including removing trailing whitespace for those files) 2016-10-04 14:31:36 -07:00
blog Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
css CRLF -> LF mod (including removing trailing whitespace for those files) 2016-10-04 14:31:36 -07:00
docs Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
static Migrate the RocksDB Worpdress blog over to Jekyll 2016-09-01 17:28:49 -07:00
.gitignore Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
2016-04-07-blog-post-example.md Add CONTRIBUTING.md for rocksdb.org contribution guidance 2016-10-04 15:19:00 -07:00
CNAME Create CNAME 2016-09-13 09:50:04 -07:00
CONTRIBUTING.md Make sure that when contribtuing we call out creating appropriate directories 2016-10-04 15:38:41 -07:00
Gemfile Add redirects from old blog posts link to new format 2016-09-06 21:07:13 -07:00
Gemfile.lock Add redirects from old blog posts link to new format 2016-09-06 21:07:13 -07:00
README.md Add link to CONTRIBUTING.md to main docs README.md 2016-10-04 15:21:43 -07:00
_config.yml Testing asset links after config change 2016-10-07 16:28:44 -07:00
_config_local_dev.yml Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
docs-hello-world.md Add CONTRIBUTING.md for rocksdb.org contribution guidance 2016-10-04 15:19:00 -07:00
feed.xml Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
index.md Initial Landing Page 2016-09-01 17:25:08 -07:00
support.md Add FAQ based on the front page of the current rocksdb.org 2016-09-01 17:34:39 -07:00
top-level-example.md Add top level doc information to CONTRIBUTING.md 2016-10-04 15:27:28 -07:00

README.md

User Documentation for rocksdb.org

This directory will contain the user and feature documentation for RocksDB. The documentation will be hosted on GitHub pages.

Contributing

See CONTRIBUTING.md for contribution details.

Run the Site Locally

The requirements for running a GitHub pages site locally is described in GitHub help. The steps below summarize these steps.

  1. Make sure you have Ruby and RubyGems installed.

    Ruby >= 2.2 is required for the gems. On the latest versions of Mac OS X, Ruby 2.0 is the default. Use brew install ruby (or your preferred upgrade mechanism) to install a newer version of Ruby for your Mac OS X system.

  2. Make sure you have Bundler installed.

    # may require sudo
gem install bundler

  3. Install the project's dependencies

    # run this in the 'docs' directory
bundle install

    If you get an error when installing nokogiri, you may be running into the problem described in this nokogiri issue. You can either brew uninstall xz (and then brew install xz after the bundle is installed) or xcode-select --install (although this may not work if you have already installed command line tools).

  4. Run Jekyll's server.

    bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml

    We use bundle exec instead of running straight jekyll because bundle exec will always use the version of Jekyll from our Gemfile. Just running jekyll will use the system version and may not necessarily be compatible.

  5. The site will be served from http://localhost:4000.

Updating the Bundle

The site depends on Github Pages and the installed bundle is based on the github-pages gem. Occasionally that gem might get updated with new or changed functionality. If that is the case, you can run:

bundle update

to get the latest packages for the installation.