|
|
||
|---|---|---|
| .github | ||
| content | ||
| data | ||
| docs | ||
| external | ||
| scripts | ||
| src | ||
| static | ||
| .env.sample | ||
| .eslintrc | ||
| .gitignore | ||
| .gitmodules | ||
| .markdownlint.json | ||
| .prettierignore | ||
| .prettierrc | ||
| .travis.yml | ||
| config.js | ||
| docker-compose.yml | ||
| Dockerfile | ||
| gatsby-browser.js | ||
| gatsby-config.js | ||
| gatsby-node.js | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
docs
🐍 Ocean Protocol's official documentation. https://docs.oceanprotocol.com
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
To write or update content, refer to the documentation of the documentation:
- Documentation: Content →
- Documentation: API References →
- Documentation: GitHub Data Fetching →
- Documentation: Repository Component →
Development
The site is a React app built with Gatsby, 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):
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:
npm i
npm start
Alternatively, you can use Docker Compose to do the same, but without using your local system:
docker-compose up
Either one of these commands will expose a hot-reloading server under:
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
- 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:
Deployment
Automatic deployments are triggered upon successful tests & builds on Travis:
- push to
masterinitiates a live deployment → docs.oceanprotocol.com - any Pull Request, and subsequent pushes to it, initiates a beta deployment → betadocs.oceanprotocol.com
The deploy command simply calls the scripts/deploy.sh script, syncing the contents of the public/ folder to S3:
npm run deploy
Requires authorization against AWS with one of the various ways, on Travis this is done with those environment variables:
AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYAWS_DEFAULT_REGION
License
Copyright 2020 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.