mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
master → main
This commit is contained in:
parent
b72f8fb2ef
commit
ceba58a2ac
@ -97,7 +97,7 @@ If you use VS Code as your editor, you can install those extensions to get linti
|
|||||||
|
|
||||||
Automatic deployments are triggered upon successful tests & builds on Travis:
|
Automatic deployments are triggered upon successful tests & builds on Travis:
|
||||||
|
|
||||||
- push to `master` initiates a live deployment
|
- push to `main` initiates a live deployment
|
||||||
→ [docs.oceanprotocol.com](https://docs.oceanprotocol.com)
|
→ [docs.oceanprotocol.com](https://docs.oceanprotocol.com)
|
||||||
- any Pull Request, and subsequent pushes to it, initiates a beta deployment
|
- any Pull Request, and subsequent pushes to it, initiates a beta deployment
|
||||||
→ [betadocs.oceanprotocol.com](https://betadocs.oceanprotocol.com)
|
→ [betadocs.oceanprotocol.com](https://betadocs.oceanprotocol.com)
|
||||||
|
@ -15,8 +15,7 @@ module.exports = {
|
|||||||
Port: 'https://port.oceanprotocol.com',
|
Port: 'https://port.oceanprotocol.com',
|
||||||
Telegram: 'https://t.me/OceanProtocol_Community'
|
Telegram: 'https://t.me/OceanProtocol_Community'
|
||||||
},
|
},
|
||||||
githubContentPath:
|
githubContentPath: 'https://github.com/oceanprotocol/docs/blob/main/content',
|
||||||
'https://github.com/oceanprotocol/docs/blob/master/content',
|
|
||||||
redirects: [
|
redirects: [
|
||||||
{
|
{
|
||||||
from: '/concepts/',
|
from: '/concepts/',
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
# Content
|
# Content
|
||||||
|
|
||||||
- [Overview](#Overview)
|
- [Overview](#overview)
|
||||||
- [External Content Files](#External-Content-Files)
|
- [External Content Files](#external-content-files)
|
||||||
- [Workflow](#Workflow)
|
- [Workflow](#workflow)
|
||||||
- [Adding Docs](#Adding-Docs)
|
- [Adding Docs](#adding-docs)
|
||||||
- [Editing Docs](#Editing-Docs)
|
- [Editing Docs](#editing-docs)
|
||||||
- [Markdown File Requirements](#Markdown-File-Requirements)
|
- [Markdown File Requirements](#markdown-file-requirements)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@ -45,7 +45,7 @@ This will NOT include this page in the doc's sidebar navigation, this needs to b
|
|||||||
1. Add new Markdown file under one of the folders under [`/content`](../content/)
|
1. Add new Markdown file under one of the folders under [`/content`](../content/)
|
||||||
1. Add new path to one of the sidebars in [`/data/sidebars`](../data/sidebars/)
|
1. Add new path to one of the sidebars in [`/data/sidebars`](../data/sidebars/)
|
||||||
1. Push your changes to a new branch in the repo, or in your fork
|
1. Push your changes to a new branch in the repo, or in your fork
|
||||||
1. Open a pull request against `master`, automatically asking for review
|
1. Open a pull request against `main`, automatically asking for review
|
||||||
1. Wait for review, possibly make requested changes
|
1. Wait for review, possibly make requested changes
|
||||||
1. Wait for all checks to pass
|
1. Wait for all checks to pass
|
||||||
1. Merge!
|
1. Merge!
|
||||||
@ -54,13 +54,13 @@ This will NOT include this page in the doc's sidebar navigation, this needs to b
|
|||||||
|
|
||||||
Every article on [docs.oceanprotocol.com](https://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.
|
Every article on [docs.oceanprotocol.com](https://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.
|
GitHub will automatically fork the repository if you are not part of the `oceanprotocol` organization on GitHub. Members can simply push to a new branch on the original repo.
|
||||||
|
|
||||||
The editing workflow is as follows:
|
The editing workflow is as follows:
|
||||||
|
|
||||||
1. Make your changes
|
1. Make your changes
|
||||||
1. Push your changes to a new branch in the repo, or in your fork
|
1. Push your changes to a new branch in the repo, or in your fork
|
||||||
1. Open a pull request against `master`, automatically asking for review
|
1. Open a pull request against `main`, automatically asking for review
|
||||||
1. Wait for review, possibly make requested changes
|
1. Wait for review, possibly make requested changes
|
||||||
1. Wait for all checks to pass
|
1. Wait for all checks to pass
|
||||||
1. Merge!
|
1. Merge!
|
||||||
|
@ -42,16 +42,16 @@ function s3sync {
|
|||||||
}
|
}
|
||||||
|
|
||||||
##
|
##
|
||||||
## check for pull request against master
|
## check for pull request against main
|
||||||
##
|
##
|
||||||
if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "master" ]; then
|
if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "main" ]; then
|
||||||
|
|
||||||
s3sync $AWS_S3_BUCKET_BETA
|
s3sync $AWS_S3_BUCKET_BETA
|
||||||
|
|
||||||
##
|
##
|
||||||
## check for master push which is no pull request
|
## check for main push which is no pull request
|
||||||
##
|
##
|
||||||
elif [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] || [ "$TRAVIS" != true ]; then
|
elif [ "$TRAVIS_BRANCH" == "main" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] || [ "$TRAVIS" != true ]; then
|
||||||
|
|
||||||
s3sync $AWS_S3_BUCKET
|
s3sync $AWS_S3_BUCKET
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user