Skip to content

Commit

Permalink
Initial Landing Page
Browse files Browse the repository at this point in the history
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
  • Loading branch information
JoelMarcey committed Sep 2, 2016
1 parent 9447a85 commit 5a0e9a4
Show file tree
Hide file tree
Showing 18 changed files with 272 additions and 719 deletions.
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ permalink: /blog/:year/:month/:day/:title.html
title: RocksDB
tagline: A persistent key-value store for fast storage environments
description: >
RocksDB is an embeddable persistent key-value store for fast storage. RocksDB can also be the foundation for a client-server database but our current focus is on embedded workloads.
RocksDB is an embeddable persistent key-value store for fast storage.
fbappid: "1615782811974223"
gacode: "UA-12345-6"
# baseurl determines the subpath of your site. For example if you're using an
Expand All @@ -16,7 +16,7 @@ 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
primary: "#3b5998"
primary: "#2a2a2a"
# 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'
Expand Down
26 changes: 13 additions & 13 deletions docs/_data/features.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
- title: Feature 1
- title: Optimized for Fast Storage
text: |
This is a description of the feature which **can** use [markdown](#).
image: images/android.svg
RocksDB is optimized for fast, low latency storage such as flash drives. RocksDB exploits the full potential of high read/write rates offered by flash or RAM.
image: images/promo-flash.svg

- title: Feature 2
- title: High Performance
text: |
This is another description of a feature.
image: images/apple.svg
- title: Feature 3
RocksDB uses a log structured database engine, written entirely in C++, for maximum performance. Keys and values are just arbitrarily-sized byte streams.
image: images/promo-performance.svg

- title: Adaptable
text: |
This is another description of a feature.
image: images/facebook.png
RocksDB can also be used as a storage engine for databases. [MongoRocks](https://github.com/mongodb-partners/mongo-rocks) and [MyRocks](https://github.com/facebook/mysql-5.6) are two production examples.
image: images/promo-adapt.svg

- title: Feature 4
- title: Basic and Advanced Database Operations
text: |
This is another description of a feature.
image: images/instagram.png
RocksDB provides basic operations such as opening and closing a database, reading and writing to more advanced operations such as slicing and iteration.
image: images/promo-operations.svg
7 changes: 1 addition & 6 deletions docs/_data/powered_by.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
- title: Who Uses This Project?
items:
- name: Example Company
url: https://www.example.com/
- name: Another Example
url: https://www.example.com
# Fill in later if desired
15 changes: 1 addition & 14 deletions docs/_data/powered_by_highlight.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1 @@
- title: Who Uses This Project?
items:
- name: Facebook
url: https://facebook.com
img: static/images/facebook.png
- name: Instagram
url: https://www.instagram.com
img: static/images/instagram.png
- name: Facebook
url: https://facebook.com
img: static/images/facebook.png
- name: Instagram
url: https://www.instagram.com
img: static/images/instagram.png
# Fill in later if desired
24 changes: 1 addition & 23 deletions docs/_data/promo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,4 @@

- type: button
href: docs/getting-started.html
text: Example Button

- type: github_star

- type: github_watch

- type: like_button

- type: google_share

- type: twitter_follow
href: FbOpenSource

- type: twitter_share

- type: plugin_row
children:
- type: button
href: docs/getting-started.html
text: Get Started
- type: button
href: https://example.com
text: Another Button
text: Get Started
44 changes: 2 additions & 42 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,9 @@
---
layout: home
title: Example - You can over-ride the default title here
title: RocksDB | A persistent key-value store
id: home
---

## Gridblocks

You can use the gridblocks sub-template to arrange information into nice responsive grids. There are two ways to add a grid block, the first is by adding a yml file to the `_data` folder and then using it as a data source:
## Features

{% include content/gridblocks.html data_source=site.data.features align="center" %}

The second is simply to use the raw HTML of the grid blocks:

<div class="gridBlock">
<div class="blockElement twoByGridBlock alignCenter">
<div class="blockContent">
<h3>Feature 1</h3>
<p>This is a description of the feature.</p>
</div>
</div>

<div class="blockElement twoByGridBlock alignCenter">
<div class="blockContent">
<h3>Feature 2</h3>
<p>This is another description of a feature.</p>
</div>
</div>
</div>

Use the first option as a preference, because it will make your site easier for non-technical folks to edit and update.

Gridblocks have additional options for layout compared to the above:

Left aligned:

{% include content/gridblocks.html data_source=site.data.features align="left" %}

Right aligned:

{% include content/gridblocks.html data_source=site.data.features align="right" %}

Images on the side:

{% include content/gridblocks.html data_source=site.data.features imagealign="side" %}

Four column layout:

{% include content/gridblocks.html data_source=site.data.features layout="fourColumn" align="center" %}
Binary file modified docs/static/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 0 additions & 42 deletions docs/static/images/android.svg

This file was deleted.

17 changes: 0 additions & 17 deletions docs/static/images/apple.svg

This file was deleted.

Binary file removed docs/static/images/facebook.png
Binary file not shown.
Binary file removed docs/static/images/instagram.png
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/static/images/promo-adapt.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/static/images/promo-flash.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/static/images/promo-operations.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5a0e9a4

Please sign in to comment.