docs/README.md

docs

🐍 Ocean Protocol's official documentation.

---

These docs are meant to be viewed on docs.oceanprotocol.com. You can still browse them here but links or images might not work in some places.

If you want to contribute to these docs, then keep reading.

---

• Content
  • Content Files
  • Markdown File Requirements
  • Adding Docs
  • Editing Docs
  • Repositories
• Development
  • Use Docker
• Linting & formatting
  • Editor setup: VS Code
• GitHub GraphQL API
• Authors
• License

Content

The documentation is split in multiple sections whose content lives in this repo:

• Core concepts: high-level explanation of concepts, assumptions, and components
• Setup: getting started for various stakeholders and use cases
• Tutorials: detailed tutorials

Those sections are defined in the /data/sections.yml file.

Content Files

Some content files live in the /content & /data folders, and is written using Markdown and YAML. That content is organized into subfolders corresponding to the sections mentioned above. The subfolder names, along with the filenames, define the final URL of a given piece of content. The final navigational organization of the content is driven through the sidebar files under /data/sidebars. Some global values used throughout the site can be set in config.js.

TODO: Additionally, some content files live in other repositories and are pulled into the site at build time, e.g.

• API references
• Component docs
• Maybe more

Markdown File Requirements

All Markdown files should use GitHub Flavored Markdown and must satisfy some extra requirements:

1. The file must begin with a section that looks like this (YAML):

   ---
   title: This is the Title in Title Case
   description: A short description of the page.
   ---
   Markdown content begins here.
   

   Note: The description value will be rendered on-page below the title, and it will also be used for description tags in the HTML header.

2. Don't include the page title or description in the Markdown section. That is, don't begin the Markdown content with # This is the Title in Title Case. Just write as if that were already there.

3. Internal links to other docs pages should be:

   • to the full absolute URL, such as https://docs.oceanprotocol.com/hello/you-are-awesome/ or https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/style-guides.md or
   • to a relative URL that looks like /concepts/terminology/ with slashes on the beginning and end, and with no .md or .html at the end (before the last slash).

Have a look at docs.oceanprotocol.com/test/ to see what content elements can be used in the docs.

Adding Docs

1. Add new Markdown file under one of the folders under /content
2. Add new path to one of the sidebars in /data/sidebars
3. ...

Editing Docs

Every article on docs.oceanprotocol.com ends with an Edit this page on GitHub link. Clicking that will put you to the right place in the repository from where you can hit the Edit pencil icon on GitHub.

GitHub will automatically fork the repository if you are not part of the oceanprotocol organisation on GitHub. Members can simply push to a new branch on the original repo.

The editing workflow is as follows:

1. Make your changes
2. Push your changes to a new branch in the repo, or in your fork
3. Open a pull request against master, automatically asking for review
4. Wait for review, possibly make requested changes
5. Wait for all checks to pass
6. Merge!

Repositories

The repositories list is currently sourced from the /data/repositories.yml file, defining the grouping, the display order, and which repos to include.

Including a repo requires only the name key and value, and it needs to be exactly the same as the repo name on GitHub:

- name: pleuston

Additional information about a repo will then be fetched automatically via GitHub's GraphQL API on build time, and re-fetched every 5 minutes on client side. You can also add a private repo to prepare for a release, it will show up as soon as it is made public on GitHub.

The above example will result in:

This repository component can also be used within any Markdown content like so:

<repo name="pleuston"></repo>

Additionally, you can attach multiple links to a repo. The GitHub link is automatically added for every repository and will always be displayed. Add more links like so:

- name: keeper-contracts
  links:
    - name: Documentation
      url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc

in /data/repositories.yml.

Development

The site is a React app built with Gatsby.

As a prerequisite you'll need on your machine:

• Node.js
• npm

Clone this repo, install all dependencies, and start the development server:

git clone --recursive git@github.com:oceanprotocol/docs.git
cd docs/

# add GITHUB_TOKEN
cp .env.sample .env
vi .env

npm i
npm start

For getting your GITHUB_TOKEN, see GitHub GraphQL API.

This will start a hot-reloading local server exposed under localhost:8000.

Use Docker

Alternatively, you can use Docker for which you need to have installed on your machine:

• Docker
• Docker Compose
• GITHUB_TOKEN in .env, see GitHub GraphQL API

Then use Docker Compose to bring everything up:

docker-compose up

This will expose a hot-reloading server under localhost:8000.

Linting & formatting

To enforce a consistent code style, linting is setup for pretty much every file. Linting is part of the test suite, meaning builds on Travis will fail in case of linting errors.

In this repo the following tools are setup for that:

• ESLint with eslint-config-oceanprotocol
• Stylelint with stylelint-config-bigchaindb
• markdownlint
• Prettier

# only run linting checks
npm run lint

# auto-formatting of all js, css, md, yml files
npm run format

Editor setup: VS Code

If you use VS Code as your editor, you can install those extensions to get linting as you type, and auto-formatting as you save:

• ESLint
• Prettier
• stylelint
• markdownlint

GitHub GraphQL API

The GitHub GraphQL API integration is done through gatsby-source-graphql and requires authorization.

An environment variable GITHUB_TOKEN needs to present, filled with a personal access token with the scope public_repo.

For local development, you can simply create a personal access token and use it in your local .env file:

cp .env.sample .env
vi .env
# GITHUB_TOKEN=add_your_token_here

When running the site locally, you can use the GraphiQL client running under localhost:8000/___graphql to explore the whole GraphQL layer of the site (not just the GitHub infos).

This query should get you started to explore what information you can get from GitHub:

query {
  github {
    organization(login: "oceanprotocol") {
      repositories(first: 100) {
        edges {
          node {
            name
            description
            url
          }
        }
      }
    }
  }
}

Authors

• Troy McConaghy (@ttmc) - Ocean Protocol
• Matthias Kretschmann (@kremalicious) - Ocean Protocol

License

Copyright 2018 Ocean Protocol Foundation Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.