rocksdb

History

Joel Marcey a182b2981d Preserve blog comments in markdown Summary: While we won't have new comments when we move to gh-pages (for now), this preserves the current comments in markdown format. Test Plan: Visual https://www.facebook.com/pxlcld/pwCR Reviewers: lgalanis, sdong Reviewed By: sdong Subscribers: jamesgpearce, andrewkr, dhruba, leveldb Differential Revision: https://reviews.facebook.net/D63783		2016-09-13 09:13:29 -07:00
..
_data	Update landing page content	2016-09-06 21:07:47 -07:00
_docs	Add FAQ based on the front page of the current rocksdb.org	2016-09-01 17:34:39 -07:00
_includes	Have "Edit on GitHub" point to master instead of gh-pages	2016-09-06 21:08:53 -07:00
_layouts	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -07:00
_posts	Preserve blog comments in markdown	2016-09-13 09:13:29 -07:00
_sass	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -07:00
blog	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -07:00
css	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -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
_config_local_dev.yml	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -07:00
_config.yml	Add real Google Analytics ID	2016-09-06 21:10:14 -07:00
.gitignore	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -07:00
feed.xml	Add initial GitHub pages infra for RocksDB documentation move and update. (#1294 )	2016-08-24 15:35:38 -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
index.md	Initial Landing Page	2016-09-01 17:25:08 -07:00
README.md	Update docs README.md	2016-08-30 08:05:43 -07:00
support.md	Add FAQ based on the front page of the current rocksdb.org	2016-09-01 17:34:39 -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.

Run the Site Locally

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

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.
Make sure you have Bundler installed.
```
# may require sudo
gem install bundler
```
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).
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.
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.