/2017.9984.io

The 9984 >> SUMMIT 2017 site

Primary LanguageJavaScript

9984 >> 2017.9984.io

The 9984 >> SUMMIT 2017 site

Blockchain Futures for Developers, Enterprises & Society
October 5 - 6, 2017
https://2017.9984.io

Build Status css bigchaindb Greenkeeper badge

Live | Beta

Table of Contents

Content editing

unknown

Most content on the site can be edited on GitHub without messing with HTML markup.

The site's source and structure is in the _src/ folder. Ignore everything with an underscore in its name.

When viewing a file on GitHub you will see a small pencil icon in the top right. Click that to edit the file.

Pages

All pages are simple Markdown files. Markdown is a way of telling the site how an element should be marked up, like headings & bold text:

I'm a simple paragraph. No fancy symbols needed.

# I'm a heading 1
## I'm a heading 2

You can make text **bold like so**

Have a look at Code of Conduct or the Imprint to see how Markdown is used.

Special pages

Some pages like front page & speakers page source their content dynamically during site build. This is so we have a single source of truth for content used in multiple places on the site.

Front page

Content for all sections on front page is coming from a data file:

Speakers & Talks

All speakers data is coming from individual speaker files in _src/_speakers

Adding / editing speakers & talks

Each content item is represented as a Markdown file with YAML at the top. The data should look something like this:

---
property: "value"
other_property:
    - "list"
    - "of"
    - "values"
---

Add new content through GitHub

  1. Click into the appropriate directory (/_src/_speakers, /_src/_talks
  2. Copy the data from an existing .md file
  3. In the parent folder, click Create new file
  4. Paste the data into GitHub and edit
  5. Edit to your heart’s content!
  • The filename you choose may determine the content page URL
  • The id property should be the same as the filename
  1. When finished, fill in a commit description and select Create a new branch for this commit and start a pull request.
  2. Wait to see if the created pull request passes the build. If it does, click merge and your changes will be live

Development

200

You need to have the following tools installed on your development machine before moving on:

Install dependencies

Run the following command from the repository's root folder to install all dependencies.

npm i && bundle install

or

yarn && bundle install

Development build

Spin up local dev server and livereloading watch task, reachable under https://localhost:1337:

gulp

Continuous deployment: always be shipping

shipping

The site gets built & deployed automatically via Travis. This is the preferred way of deployment, it makes sure the site is always deployed with fresh dependencies and only after a successful build.

Build & deployment happens under the following conditions on Travis:

  • every push builds the site
  • live deployment: every push to the master branch initiates a live deployment
  • beta deployment: every new pull request and every subsequent push to it initiates a beta deployment

Manual deployment

For emergency live deployments or beta & gamma deployments, the manual method can be used. The site is hosted in an S3 bucket and gets deployed via a gulp task.

Prerequisite: authentication

To deploy the site, you must authenticate yourself against the AWS API with your AWS credentials. Get your AWS access key and secret and add them to ~/.aws/credentials:

[default]
aws_access_key_id = <YOUR_ACCESS_KEY_ID>
aws_secret_access_key = <YOUR_SECRET_ACCESS_KEY>

This is all that is needed to authenticate with AWS if you've setup your credentials as the default profile.

If you've set them up as another profile, say [9984] you can grab those credentials by using the AWS_PROFILE variable like so:

AWS_PROFILE=9984 gulp deploy --live

In case that you get authentication errors or need an alternative way to authenticate with AWS, check out the AWS documentation.

Staging build & beta deployment

The staging build is a full production build but prevents search engine indexing & Google Analytics tracking.

# make sure your local npm packages & gems are up to date
npm update && bundle update

# make staging build in /_dist
# build preventing search engine indexing & Google Analytics tracking
gulp build --staging

# deploy contents of /_dist to beta
gulp deploy --beta

Production build & live deployment

# make sure your local npm packages & gems are up to date
npm update && bundle update

# make production build in /_dist
gulp build --production

# deploy contents of /_dist to live
gulp deploy --live

Coding conventions

(S)CSS

Follows stylelint-config-bigchaindb which itself extends stylelint-config-standard.

Lint with stylelint in your editor or run:

npm test

Authors