mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-02 16:25:37 +01:00
142 lines
5.4 KiB
Markdown
142 lines
5.4 KiB
Markdown
[](https://docs.oceanprotocol.com)
|
|
|
|
<h1 align="center">docs</h1>
|
|
|
|
> 🐍 Ocean Protocol's official documentation. https://docs.oceanprotocol.com
|
|
|
|
[](https://travis-ci.com/oceanprotocol/docs)
|
|
[](https://github.com/prettier/prettier)
|
|
[](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
|
|
[](https://github.com/bigchaindb/stylelint-config-bigchaindb)
|
|
[](https://greenkeeper.io/)
|
|
|
|
---
|
|
|
|
**These docs are meant to be viewed on [docs.oceanprotocol.com](https://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)
|
|
- [Development](#Development)
|
|
- [Linting & Formatting](#Linting--Formatting)
|
|
- [Editor Setup: VS Code](#Editor-Setup-VS-Code)
|
|
- [Deployment](#Deployment)
|
|
- [Authors](#Authors)
|
|
- [License](#License)
|
|
|
|
## Content
|
|
|
|
To write or update content, refer to the documentation of the documentation:
|
|
|
|
- [**Documentation: Content →**](docs/content.md)
|
|
- [**Documentation: API References →**](docs/apis.md)
|
|
- [**Documentation: GitHub Data Fetching →**](docs/github.md)
|
|
- [**Documentation: Repository Component →**](docs/repositories.md)
|
|
|
|
## Development
|
|
|
|
The site is a React app built with [Gatsby](https://www.gatsbyjs.org), pulling its content from local and external Markdown files, and from various APIs.
|
|
|
|
To start, clone this repo and set your `GITHUB_TOKEN` (see [GitHub GraphQL API](docs/github.md#GitHub-GraphQL-API)):
|
|
|
|
```bash
|
|
git clone --recurse-submodules git@github.com:oceanprotocol/docs.git
|
|
cd docs/
|
|
|
|
# add GITHUB_TOKEN
|
|
cp .env.sample .env
|
|
vi .env
|
|
```
|
|
|
|
Then install dependencies and start up the development server:
|
|
|
|
```bash
|
|
npm i
|
|
npm start
|
|
```
|
|
|
|
Alternatively, you can use [Docker Compose](https://docs.docker.com/compose/) to do the same, but without using your local system:
|
|
|
|
```bash
|
|
docker-compose up
|
|
```
|
|
|
|
Either one of these commands will expose a hot-reloading server under:
|
|
|
|
- [localhost:8000](http://localhost:8000)
|
|
- [localhost:8000/\_\_\_graphql](http://localhost:8000/___graphql)
|
|
|
|
## 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](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
|
|
- Stylelint with [stylelint-config-bigchaindb](https://github.com/bigchaindb/stylelint-config-bigchaindb)
|
|
- [markdownlint](https://github.com/DavidAnson/markdownlint)
|
|
- [Prettier](https://prettier.io)
|
|
|
|
```bash
|
|
# 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](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
- [stylelint](https://marketplace.visualstudio.com/items?itemName=shinnn.stylelint)
|
|
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
|
|
|
## Deployment
|
|
|
|
Automatic deployments are triggered upon successful tests & builds on Travis:
|
|
|
|
- push to `master` initiates a live deployment
|
|
→ [docs.oceanprotocol.com](https://docs.oceanprotocol.com)
|
|
- any Pull Request, and subsequent pushes to it, initiates a beta deployment
|
|
→ [betadocs.oceanprotocol.com](https://betadocs.oceanprotocol.com)
|
|
|
|
The deploy command simply calls the [`scripts/deploy.sh`](scripts/deploy.sh) script, syncing the contents of the `public/` folder to S3:
|
|
|
|
```bash
|
|
npm run deploy
|
|
```
|
|
|
|
Requires authorization against AWS with [one of the various ways](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html), on Travis this is done with those environment variables:
|
|
|
|
- `AWS_ACCESS_KEY_ID`
|
|
- `AWS_SECRET_ACCESS_KEY`
|
|
- `AWS_DEFAULT_REGION`
|
|
|
|
## Authors
|
|
|
|
- Troy McConaghy ([@ttmc](https://github.com/ttmc)) - [Ocean Protocol](https://oceanprotocol.com)
|
|
- Matthias Kretschmann ([@kremalicious](https://github.com/kremalicious)) - [Ocean Protocol](https://oceanprotocol.com)
|
|
|
|
## License
|
|
|
|
```text
|
|
Copyright 2019 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.
|
|
```
|