Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

88 lines (53 loc) · 1.5 KB
Raw

Contributing

The documentation is open for contributors pull requests or issues.

This is a jekyll project.

Pages are at the root folder, written in markdown (*.md).

There is also full examples pages in examples/.

Installation

git clone [email protected]:eole-io/sandstone-doc.git
cd sandstone-doc/

Preview

Using docker:

make

Or from raw installation:

bundle exec jekyll serve

Then go to http://localhost:4000/sandstone/ (don't forget trailing slash).

It will watch for file changes, so just refresh after your changes.

Reindex search

Using docker:

First create docker-compose.override.yml with content:

version: '2'

services:
    jekyll:
        environment:
            ALGOLIA_API_KEY: xxx # My secret key from dashboard

Then:

make update_search_index

Publish

You need write access to publish, and it'll ask for a third party access token.

Using docker:

Run:

make publish

Or from raw installation:

Full publish documentation script (from a blank folder): see docker/jekyll/publish.sh as an example.

Live examples

Live examples needs a server with eole-io/sandstone-doc-live installed and running.

You can rely one the production one, or, to edit it, install a local instance (easily with Docker) and use it by setting your hosts in js/live-examples.js (bottom of the file).