5a0e9a4cfa
Summary: This is the proof of concept for the initial landing page for RocksDB when we move to GitHub pages. The images for each feature can change, but using these as placeholders for now. The styling may change a bit as well. Test Plan: Visual Reviewers: IslamAbdelRahman, lgalanis, sdong Reviewed By: lgalanis Subscribers: andrewkr, dhruba, leveldb Differential Revision: https://reviews.facebook.net/D62985 |
||
|---|---|---|
| .. | ||
| _data | ||
| _docs | ||
| _includes | ||
| _layouts | ||
| _posts | ||
| _sass | ||
| blog | ||
| css | ||
| docs | ||
| static | ||
| .gitignore | ||
| _config.yml | ||
| _config_local_dev.yml | ||
| feed.xml | ||
| Gemfile | ||
| Gemfile.lock | ||
| index.md | ||
| README.md | ||
| support.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 installIf you get an error when installing
nokogiri, you may be running into the problem described in this nokogiri issue. You can eitherbrew uninstall xz(and thenbrew install xzafter the bundle is installed) orxcode-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.ymlWe use
bundle execinstead of running straightjekyllbecausebundle execwill always use the version of Jekyll from ourGemfile. Just runningjekyllwill 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.