dolysis/rocksdb
3
0
Fork 0
mirror of https://github.com/facebook/rocksdb.git synced 2024-11-27 11:43:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
rocksdb/docs/_config.yml

69 lines
2.1 KiB
YAML
Raw Normal View History

Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
# Site settings
permalink: /blog/:year/:month/:day/:title.html
title: RocksDB
tagline: A persistent key-value store for fast storage environments
description: >
Initial Landing Page 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
2016-09-02 00:25:08 +00:00
RocksDB is an embeddable persistent key-value store for fast storage.
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
fbappid: "1615782811974223"
Add real Google Analytics ID Summary: This adds the actual RocksDB Google Analytics ID that will be used when we switch over from WP to GH-pages Test Plan: visual Reviewers: IslamAbdelRahman, lgalanis, sdong Reviewed By: sdong Subscribers: sdong, andrewkr, dhruba, leveldb Differential Revision: https://reviews.facebook.net/D63429
2016-09-07 04:10:14 +00:00
gacode: "UA-49459723-1"
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
# baseurl determines the subpath of your site. For example if you're using an
# organisation.github.io/reponame/ basic site URL, then baseurl would be set
# as "/reponame/" but leave blank if you have a top-level domain URL
Testing asset links after config change
2016-10-07 23:28:44 +00:00
# https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
baseurl: ""
url: "http://rocksdb.org" # the base hostname & protocol for your site
ghrepo: "facebook/rocksdb"
# Use these color settings to determine your colour scheme for the site.
color:
# primary should be a vivid color that reflects the project's brand
Initial Landing Page 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
2016-09-02 00:25:08 +00:00
primary: "#2a2a2a"
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
# secondary should be a subtle light or dark color used on page backgrounds
secondary: "#f9f9f9"
# Use the following to specify whether the previous two colours are 'light'
# or 'dark' and therefore what colors can be overlaid on them
primary-overlay: "dark"
secondary-overlay: "light"
#Uncomment this if you want to enable Algolia doc search with your own values
#searchconfig:
# apikey: ""
# indexname: ""
A bit of doc restructuring
2016-10-13 03:21:18 +00:00
# Blog posts are builtin to Jekyll by default, with the `_posts` directory.
# Here you can specify other types of documentation. The names here are `docs`
# and `top-level`. This means their content will be in `_docs` and `_top-level`.
# The permalink format is also given.
# http://ben.balter.com/2015/02/20/jekyll-collections/
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
collections:
docs:
output: true
permalink: /docs/:name/
A bit of doc restructuring
2016-10-13 03:21:18 +00:00
top-level:
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
output: true
A bit of doc restructuring
2016-10-13 03:21:18 +00:00
permalink: :name.html
Add initial GitHub pages infra for RocksDB documentation move and update. (#1294) This is the initial commit with the templates necessary to have our RocksDB user documentation hosted on GitHub pages. Ensure you meet requirements here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements Then you can run this right now by doing the following: ``` % bundle install % bundle exec jekyll serve --config=_config.yml,_config_local_dev.yml ``` Then go to: http://127.0.0.1:4000/ Obviously, this is just the skeleton. Moving forward we will do these things in separate pull requests: - Replace logos with RocksDB logos - Update the color schemes - Add current information on rocksdb.org to markdown in this infra - Migrate current Wodpress blog to Jekyll and Disqus comments - Etc.
2016-08-24 22:35:38 +00:00
# DO NOT ADJUST BELOW THIS LINE UNLESS YOU KNOW WHAT YOU ARE CHANGING
markdown: kramdown
kramdown:
input: GFM
syntax_highlighter: rouge
syntax_highlighter_opts:
css_class: 'rougeHighlight'
span:
line_numbers: false
block:
line_numbers: true
start_line: 1
sass:
style: :compressed
redcarpet:
extensions: [with_toc_data]
Add redirects from old blog posts link to new format Summary: The new blog post links will be formatted differently coming over to gh-pages. But we can redirect from the old style over to the new style for existing blog posts. Test Plan: Visual https://www.facebook.com/pxlcld/pvWQ Reviewers: lgalanis, sdong Reviewed By: sdong Subscribers: andrewkr, dhruba, leveldb Differential Revision: https://reviews.facebook.net/D63513
2016-09-07 04:07:13 +00:00
gems:
- jekyll-redirect-from
Reference in a new issue Copy permalink