andreacavalli/rocksdb
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
557034f362
rocksdb/docs
History
Joel Marcey 557034f362 Remove all instances of baseurl 
rocksdb hit the problem that nuclide had.

https://github.com/facebook/nuclide/issues/789
https://github.com/facebook/nuclide/pull/793
2016-11-03 10:29:33 -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 Remove all instances of baseurl 2016-11-03 10:29:33 -07:00
_layouts A bit of doc restructuring 2016-10-12 20:23:00 -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
_top-level A bit of doc restructuring 2016-10-12 20:23:00 -07:00
blog Remove all instances of baseurl 2016-11-03 10:29:33 -07:00
css Remove all instances of baseurl 2016-11-03 10:29:33 -07:00
doc-type-examples A bit of doc restructuring 2016-10-12 20:23:00 -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 Remove all instances of baseurl 2016-11-03 10:29:33 -07:00
_config.yml Remove all instances of baseurl 2016-11-03 10:29:33 -07:00
.gitignore Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 2016-08-24 15:35:38 -07:00
CNAME Create CNAME 2016-09-13 09:50:04 -07:00
CONTRIBUTING.md A bit of doc restructuring 2016-10-12 20:23:00 -07:00
feed.xml Remove all instances of baseurl 2016-11-03 10:29:33 -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 Editorial change to README.md 2016-10-12 20:24:50 -07:00
TEMPLATE-INFORMATION.md A bit of doc restructuring 2016-10-12 20:23:00 -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 details on how to add or modify content.

Run the Site Locally

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

If you have run the site before, you can start with step 1 and then move on to step 5.

  1. Ensure that you are in the /docs directory in your local RocksDB clone (i.e., the same directory where this README.md exists). The below RubyGems commands, etc. must be run from there.

  2. 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.

  3. Make sure you have Bundler installed.

    # may require sudo
gem install bundler

  4. 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).

  5. Run Jekyll's server.

    • On first runs or for structural changes to the documentation (e.g., new sidebar menu item), do a full build.
    bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml
    • For content changes only, you can use --incremental for faster builds.
    bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml --incremental

    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 _config_local_dev file overrides some URL settings that you might be using in production to allow you to test links, etc. locally.

  6. Either of commands in the previous step will serve up the site on your local device at http://127.0.0.1:4000/ or 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.