bigchaindb/site
1
0
Fork 0
mirror of https://github.com/bigchaindb/site.git synced 2024-12-24 02:16:10 +01:00
Code Releases Activity

content as data, build out docs section

Browse Source
This commit is contained in:
Matthias Kretschmann 2017-06-27 12:10:36 +02:00
parent 46da05a1ca
commit b36be8e460
Signed by: m
GPG Key ID: 606EEEF3C479A91F
4 changed files with 187 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
_src/_assets/images/icon-book.svg Normal file
View File

@ -0,0 +1,7 @@
<svg xmlns="http://www.w3.org/2000/svg" width="18" height="24" viewBox="0 0 18 24">
<g fill="#000000">
<path d="M5.5,16 L4,16 L4,17 L5.5,17 C5.775,17 6,16.775 6,16.5 C6,16.224 5.775,16 5.5,16 Z"/>
<path d="M17.5,4 L17,4 L17,0.5 C17,0.224 16.775,0 16.5,0 L2.5,0 C1.121,0 0,1.122 0,2.5 L0,21.5 C0,22.878 1.121,24 2.5,24 L17.5,24 C17.775,24 18,23.776 18,23.5 L18,4.5 C18,4.224 17.775,4 17.5,4 Z M7,18.5 C7,19.327 6.327,20 5.5,20 L3.5,20 C3.224,20 3,19.776 3,19.5 L3,15.5 C3,15.223 3.224,15 3.5,15 L5.5,15 C6.327,15 7,15.673 7,16.5 C7,16.883 6.856,17.234 6.617,17.5 C6.856,17.765 7,18.115 7,18.5 Z M10.5,13 C10.224,13 10,12.776 10,12.5 L10,12 L8,12 L8,12.5 C8,12.776 7.776,13 7.5,13 C7.224,13 7,12.776 7,12.5 L7,10 C7,8.896 7.898,8 9,8 C10.102,8 11,8.896 11,10 L11,12.5 C11,12.776 10.776,13 10.5,13 Z M13.5,19 L14.5,19 C14.776,19 15,19.223 15,19.5 C15,19.776 14.776,20 14.5,20 L13.5,20 C12.121,20 11,18.878 11,17.5 C11,16.121 12.121,15 13.5,15 L14.5,15 C14.776,15 15,15.223 15,15.5 C15,15.776 14.776,16 14.5,16 L13.5,16 C12.673,16 12,16.673 12,17.5 C12,18.327 12.673,19 13.5,19 Z M16,4 L15,4 L15,2.5 C15,2.224 14.775,2 14.5,2 L2.5,2 C2.224,2 2,2.224 2,2.5 C2,2.776 2.224,3 2.5,3 L14,3 L14,4 L2.5,4 C1.673,4 1,3.327 1,2.5 C1,1.673 1.673,1 2.5,1 L16,1 L16,4 Z"/>
<path d="M9 9C8.448 9 8 9.448 8 10L8 11 10 11 10 10C10 9.448 9.552 9 9 9zM5.5 18L4 18 4 19 5.5 19C5.775 19 6 18.775 6 18.5 6 18.224 5.775 18 5.5 18z"/>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.4 KiB

54
_src/_assets/styles/_page-getstarted.scss
View File

@ -176,7 +176,7 @@
.driver {
padding: $spacer;
background: rgba($brand-main-blue-light, .15);
background: rgba($brand-main-blue-dark, .15);
border-radius: $border-radius;
display: flex;
flex-wrap: wrap;
@ -263,6 +263,29 @@
//
// Section: Docs
//
.docs__title {
@extend .h3;
margin-top: 0;
}
.docs__list {
padding-left: 0;
li {
display: block;
}
a {
color: $brand-primary;
box-shadow: none;
&:hover,
&:focus {
box-shadow: inset 0 -2px 0 $brand-primary;
background: transparent;
}
}
}
//
// Section: Community
@ -276,11 +299,6 @@
}
}
.grid h1 {
@extend .h3;
margin-top: 0;
}
.social-link {
&,
.icon {
@ -289,6 +307,7 @@
display: inline-block;
box-shadow: none;
padding: $btn-padding-y-sm $btn-padding-x-sm;
margin-top: $spacer;
&:focus,
&:hover {
@ -332,29 +351,34 @@
display: block;
text-align: center;
}
h5 {
margin-top: 0;
}
}
.community__actions {
border-bottom: 1px solid $gray-dark;
margin-bottom: $spacer * 3;
padding-bottom: $spacer * 3;
h5 {
margin-top: $spacer / 2;
margin-bottom: $spacer / 4;
}
padding-bottom: $spacer * 2;
.icon {
width: 2rem;
height: 2rem;
fill: $brand-main-blue-dark;
opacity: .6;
fill: $brand-main-blue-light;
opacity: .4;
margin-bottom: $spacer / 2;
}
.icon--gitter {
stroke: $brand-main-blue-dark;
stroke: $brand-main-blue-light;
stroke-width: 2;
}
p {
color: $brand-main-blue-light;
opacity: .8;
}
}
//

91
_src/_data/getstarted.yml Normal file
View File

@ -0,0 +1,91 @@
# ----------------------------
# Section: First transaction
# ----------------------------
firsttransaction:
title:
description:
# ----------------------------
# Section: Server
# ----------------------------
server:
title: "Server"
description: "Server is cool but what you really want is IPDB. Install, installation"
ipdb:
pretitle: "Managed"
title: "IPDB: the public BigchainDB network"
description: "No need for any installation. Sign up and connect instantly, we handle running a BigchainDB production node for you."
button: "Get IPDB"
bdb:
pretitle: "Self-hosted"
title: "BigchainDB Server"
description: "If you want to run your own BigchainDB instance you can either install on Linux or with Docker on any system."
button: "Install BigchainDB Server"
# ----------------------------
# Section: Drivers
# ----------------------------
drivers:
title: "Drivers & tools"
description: "Get one of the drivers to connect to IPDB or your BigchainDB server instance."
title_official: "Official drivers"
title_tools: "Official tools"
title_community: "Community drivers"
# ----------------------------
# Section: Docs
# ----------------------------
docs:
title: "Documentation"
description: "Dive into our documentation or learn or code."
categories:
- title: "Tutorials"
items:
- title:
link:
- title: "Code examples"
items:
- title: "Kyber"
link: "https://github.com/bigchaindb/kyber"
- title: "Reference"
items:
- title: "HTTP API Reference"
link: "https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html"
- title: "Server Command Line Interface (CLI)"
link: "https://docs.bigchaindb.com/projects/server/en/latest/server-reference/bigchaindb-cli.html"
- title: "Server Configuration Settings"
link: "https://docs.bigchaindb.com/projects/server/en/latest/server-reference/configuration.html"
- title: "WebSocket Event Stream API"
link: "https://docs.bigchaindb.com/projects/server/en/latest/websocket-event-stream-api.html"
# ----------------------------
# Section: Community
# ----------------------------
community:
title: "Community"
description: "There are many ways you can contribute to the BigchainDB project, some very easy and others more involved. We welcome all potential contributors, so we ask that everyone participating abide by some simple guidelines."
gitter:
text: "Start a chat with us on Gitter."
button: "Chat on Gitter"
github:
text: "So you found a bug? Report it!"
button: "Open an issue"
guidelines:
text: "Read up on our community guidelines."
button: "Read Guidelines"
follow:
title: "Follow"
description: "Follow us for the latest updates"

97
_src/getstarted.html
View File

@ -11,6 +11,8 @@ redirect_from:
- /start/
---
{% assign content = site.data.getstarted %}
<section class="section section--firsttransaction">
<div class="row">
<header class="section-header">
@ -74,10 +76,10 @@ redirect_from:
<nav class="menu--sub" data-gumshoe-header>
<div class="row row--wide">
<div class="menu-overflow" data-gumshoe>
<a class="menu__link scroll" href="#server">Server</a>
<a class="menu__link scroll" href="#drivers">Drivers &amp; Tools</a>
<a class="menu__link scroll" href="#docs">Documentation</a>
<a class="menu__link scroll" href="#community">Community</a>
<a class="menu__link scroll" href="#server">{{ content.server.title }}</a>
<a class="menu__link scroll" href="#drivers">{{ content.drivers.title }}</a>
<a class="menu__link scroll" href="#docs">{{ content.docs.title }}</a>
<a class="menu__link scroll" href="#community">{{ content.community.title }}</a>
</div>
</div>
</nav>
@ -93,8 +95,8 @@ redirect_from:
<section class="section section--server background--darker" id="server">
<div class="row row--wide">
<header class="section-header text-left">
<h1 class="section-title section-title--numbered"><span>1</span> Server</h1>
<p class="section-description">Server is cool but what you really want is IPDB. Install, installation</p>
<h1 class="section-title section-title--numbered"><span>1</span> {{ content.server.title }}</h1>
<p class="section-description">{{ content.server.description }}</p>
</header>
</div>
@ -110,16 +112,16 @@ redirect_from:
<div class="row row--wide">
<div class="grid grid--full grid-small--half grid--gutters">
<div class="grid__col">
<span class="pretitle">Managed</span>
<h2 class="choice__title">IPDB: the public BigchainDB network</h2>
<p>No need for any installation. Sign up and connect instantly, we handle running a BigchainDB production node for you.</p>
<a class="btn btn-primary" href="">Get IPDB</a>
<span class="pretitle">{{ content.server.ipdb.pretitle }}</span>
<h2 class="choice__title">{{ content.server.ipdb.title }}</h2>
<p>{{ content.server.ipdb.description }}</p>
<a class="btn btn-primary" href="">{{ content.server.ipdb.button }}</a>
</div>
<div class="grid__col">
<span class="pretitle">Self-hosted</span>
<h2 class="choice__title">BigchainDB Server</h2>
<p>If you want to run your own BigchainDB instance you can either install on Linux or with Docker on any system.</p>
<a class="btn btn-secondary" href="">Install BigchainDB Server</a>
<span class="pretitle">{{ content.server.bdb.pretitle }}</span>
<h2 class="choice__title">{{ content.server.bdb.title }}</h2>
<p>{{ content.server.bdb.description }}</p>
<a class="btn btn-secondary" href="">{{ content.server.bdb.button }}</a>
</div>
</div>
</div>
@ -130,8 +132,8 @@ redirect_from:
<section class="section section--drivers background--darker" id="drivers">
<div class="row row--wide">
<header class="section-header text-left">
<h1 class="section-title section-title--numbered"><span>2</span> Drivers &amp; Tools</h1>
<p class="section-description">Get one of the drivers to connect to IPDB or your BigchainDB server instance.</p>
<h1 class="section-title section-title--numbered"><span>2</span> {{ content.drivers.title }}</h1>
<p class="section-description">{{ content.drivers.description }}</p>
</header>
</div>
@ -149,7 +151,7 @@ redirect_from:
<div class="grid grid--full grid-small--half grid--gutters">
<div class="grid__col">
<h3 class="choice__title">Official drivers</h3>
<h3 class="choice__title">{{ content.drivers.title_official }}</h3>
<div class="grid grid--full grid-small--half grid--gutters">
@ -174,7 +176,7 @@ redirect_from:
</div>
<div class="grid__col">
<h3 class="choice__title">Official tools</h3>
<h3 class="choice__title">{{ content.drivers.title_tools }}</h3>
<div class="grid grid--full grid-small--half grid--gutters">
{% for driver in site.data.drivers.tools %}
@ -197,7 +199,7 @@ redirect_from:
</div>
<div class="row row--wide">
<h3 class="choice__title">Community drivers</h3>
<h3 class="choice__title">{{ content.drivers.title_community }}</h3>
<div class="grid grid--half grid-medium--fit grid--gutters">
{% for driver in site.data.drivers.community %}
@ -223,21 +225,26 @@ redirect_from:
<section class="section section--docs background--light" id="docs">
<div class="row row--wide">
<header class="section-header">
<h1 class="section-title section-title--numbered"><span>3</span> Next Up</h1>
<p class="section-description">Dive into our documentation or learn or code.</p>
<h1 class="section-title section-title--numbered"><span>3</span> {{ content.docs.title }}</h1>
<p class="section-description">{{ content.docs.description }}</p>
</header>
</div>
<div class="row row--wide">
<div class="grid grid--full grid-small--fit grid--gutters">
<div class="grid__col">
<h3>Tutorials</h3>
</div>
<div class="grid__col">
<h3>Code examples</h3>
</div>
<div class="grid__col">
<h3>Documentation</h3>
</div>
{% for category in content.docs.categories %}
<div class="grid__col">
<h2 class="docs__title">{{ category.title }}</h2>
<ul class="docs__list">
{% for item in category.items %}
<li><a href="{{ item.link }}">{{ item.title }}</a></li>
{% endfor %}
</ul>
</div>
{% endfor %}
</div>
</div>
</section>
@ -245,8 +252,8 @@ redirect_from:
<section class="section section--community" id="community">
<div class="row">
<header class="section-header">
<h1 class="section-title section-title--numbered"><span>4</span> Community</h1>
<p class="section-description">There are many ways you can contribute to the BigchainDB project, some very easy and others more involved. We welcome all potential contributors, so we ask that everyone participating abide by some simple guidelines.</p>
<h1 class="section-title section-title--numbered"><span>4</span> {{ content.community.title }}</h1>
<p class="section-description">{{ content.community.description }}</p>
</header>
</div>
@ -256,26 +263,22 @@ redirect_from:
<svg class="icon icon--social icon--gitter">
<use xlink:href="/assets/img/sprite.svg#gitter"></use>
</svg>
<h5>Chat on Gitter</h5>
<p>Start a chat with us on Gitter.</p>
<a href="{{ site.social.gitter.url }}" class="btn btn-primary btn-sm">
Chat on Gitter
</a>
<p>{{ content.community.gitter.text }}</p>
<a href="{{ site.social.gitter.url }}" class="btn btn-primary btn-sm">{{ content.community.gitter.button }}</a>
</div>
<div class="grid__col">
<svg class="icon icon--social icon--github">
<use xlink:href="/assets/img/sprite.svg#github"></use>
</svg>
<h5>Open an issue</h5>
<p>So you found a bug? Report it!</p>
<a href="{{ site.social.github.url }}/{{ site.social.github.repo }}" class="btn btn-primary btn-sm">
Open issue
</a>
<p>{{ content.community.github.text }}</p>
<a href="{{ site.social.github.url }}/{{ site.social.github.repo }}" class="btn btn-primary btn-sm">{{ content.community.github.button }}</a>
</div>
<div class="grid__col">
<h5>Guidelines</h5>
<p>Read up on our community guidelines.</p>
<a href="{{ site.social.github.url }}/{{ site.social.github.repo }}/blob/master/CONTRIBUTING.md" class="btn btn-primary btn-sm">Read Guidelines</a>
<svg class="icon icon--social icon--github">
<use xlink:href="/assets/img/sprite.svg#icon-book"></use>
</svg>
<p>{{ content.community.guidelines.text }}</p>
<a href="{{ site.social.github.url }}/{{ site.social.github.repo }}/blob/master/CONTRIBUTING.md" class="btn btn-primary btn-sm">{{ content.community.guidelines.button }}</a>
</div>
</div>
</div>
@ -283,8 +286,8 @@ redirect_from:
<div class="row">
<div class="grid grid--full grid-small--fit grid--gutters">
<div class="grid__col">
<h5>Follow</h5>
<p>Follow us for the latest updates</p>
<h5>{{ content.community.follow.title }}</h5>
<p>{{ content.community.follow.description }}</p>
{% for link in site.social %}
<a class="social-link js-social-link" href="{{ link[1].url }}" title="{{ link[1].title }}">