You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
rocksdb/docs
Joel Marcey 4439b4596e Add documentation license 8 years ago
..
_data Make the header links a bit more flexible 8 years ago
_docs Add FAQ based on the front page of the current rocksdb.org 8 years ago
_includes Remove all instances of relative_url until GitHub pages problem is fixed. 8 years ago
_layouts A bit of doc restructuring 8 years ago
_posts Blog post for releasing 5.2.1 8 years ago
_sass CRLF -> LF mod (including removing trailing whitespace for those files) 8 years ago
_top-level Reword support a little bit to more clear and concise 8 years ago
blog Remove all instances of relative_url until GitHub pages problem is fixed. 8 years ago
css Remove all instances of relative_url until GitHub pages problem is fixed. 8 years ago
doc-type-examples A bit of doc restructuring 8 years ago
docs Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
static Add pcache documentation images 8 years ago
.gitignore Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
CNAME Create CNAME 8 years ago
CONTRIBUTING.md Update product and feature template for Jekyll 3.3 8 years ago
Gemfile Update product and feature template for Jekyll 3.3 8 years ago
Gemfile.lock Update product and feature template for Jekyll 3.3 8 years ago
LICENSE-DOCUMENTATION Add documentation license 8 years ago
README.md Update product and feature template for Jekyll 3.3 8 years ago
TEMPLATE-INFORMATION.md A bit of doc restructuring 8 years ago
_config.yml CSS issues are arising on the Github Pages side. Temp fix. 8 years ago
feed.xml single quotes in feed 8 years ago
index.md Initial Landing Page 8 years ago

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
    
    • For content changes only, you can use --incremental for faster builds.
    bundle exec jekyll serve --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.

    • To run using an actual IP address, you can use --host=0.0.0.0
    bundle exec jekyll serve --host=0.0.0.0
    

    This will allow you to use the IP address associated with your machine in the URL. That way you could share it with other people.

    e.g., on a Mac, you can your IP address with something like ifconfig | grep "inet " | grep -v 127.0.0.1.

  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.