mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-02 16:25:37 +01:00
119 lines
4.4 KiB
Markdown
119 lines
4.4 KiB
Markdown
[](https://docs.oceanprotocol.com)
|
||
|
||
<h1 align="center">docs</h1>
|
||
|
||
> 🐬 Ocean Protocol documentation. https://docs.oceanprotocol.com
|
||
|
||
[](https://github.com/oceanprotocol/docs/actions)
|
||
[](https://app.netlify.com/sites/docs-oceanprotocol/deploys)
|
||
[](https://codeclimate.com/github/oceanprotocol/docs/maintainability)
|
||
[](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
|
||
[](https://github.com/bigchaindb/stylelint-config-bigchaindb)
|
||
|
||
---
|
||
|
||
**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)
|
||
- [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 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)
|
||
- [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)
|
||
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
||
|
||
## ⬆️ Deployment
|
||
|
||
Every branch or Pull Request is automatically deployed by [Netlify](https://netlify.com) with their GitHub integration. A link to a preview deployment will appear under each Pull Request.
|
||
|
||
The latest deployment of the `main` branch is automatically aliased to `docs.oceanprotocol.com`.
|
||
|
||
## License
|
||
|
||
```text
|
||
Copyright ((C)) 2021 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.
|
||
```
|