NextGraph
/
rocksdb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
5460 Commits
4 Branches
0 Tags
169 MiB
 
 
 
 
 
 
Tag: Branch: Tree: 7cbb298dbe
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7cbb298dbe'
${ noResults }
rocksdb/docs
History
Joel Marcey 7cbb298dbe
Make sure that when contribtuing we call out creating appropriate directories 		8 years ago
..
_data Add author fields to blog posts 8 years ago
_docs Add FAQ based on the front page of the current rocksdb.org 8 years ago
_includes CRLF -> LF mod (including removing trailing whitespace for those files) 8 years ago
_layouts CRLF -> LF mod (including removing trailing whitespace for those files) 8 years ago
_posts Forgot to truncate one blog post 8 years ago
_sass CRLF -> LF mod (including removing trailing whitespace for those files) 8 years ago
blog Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
css CRLF -> LF mod (including removing trailing whitespace for those files) 8 years ago
docs Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
static Migrate the RocksDB Worpdress blog over to Jekyll 8 years ago
.gitignore Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
2016-04-07-blog-post-example.md Add CONTRIBUTING.md for rocksdb.org contribution guidance 8 years ago
CNAME Create CNAME 8 years ago
CONTRIBUTING.md Make sure that when contribtuing we call out creating appropriate directories 8 years ago
Gemfile Add redirects from old blog posts link to new format 8 years ago
Gemfile.lock Add redirects from old blog posts link to new format 8 years ago
README.md Add link to CONTRIBUTING.md to main docs README.md 8 years ago
_config.yml Add real Google Analytics ID 8 years ago
_config_local_dev.yml Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
docs-hello-world.md Add CONTRIBUTING.md for rocksdb.org contribution guidance 8 years ago
feed.xml Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) 8 years ago
index.md Initial Landing Page 8 years ago
support.md Add FAQ based on the front page of the current rocksdb.org 8 years ago
top-level-example.md Add top level doc information to CONTRIBUTING.md 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 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.