🦞 Landing page for listing our data science tools and directing people to them https://datascience.oceanprotocol.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Matthias Kretschmann 9fbada39f3
Merge pull request #29 from oceanprotocol/dependabot/npm_and_yarn/eslint-7.2.0
2 years ago
.github formatting, add package-lock 2 years ago
src format 4 years ago
.babelrc drop da base 🦞🍸 4 years ago
.editorconfig drop da base 🦞🍸 4 years ago
.eslintrc drop da base 🦞🍸 4 years ago
.gitignore formatting, add package-lock 2 years ago
.prettierignore drop da base 🦞🍸 4 years ago
.prettierrc drop da base 🦞🍸 4 years ago
.travis.yml lock Node.js version on Travis 3 years ago
README.md package updates 3 years ago
content.yml copy & design updates 4 years ago
deploy.sh drop da base 🦞🍸 4 years ago
gulpfile.babel.js formatting, add package-lock 2 years ago
package-lock.json Bump eslint from 7.1.0 to 7.2.0 2 years ago
package.json Bump eslint from 7.1.0 to 7.2.0 2 years ago

README.md

banner

datascience

🦞 Landing page for listing our data science tools and directing people to them https://datascience.oceanprotocol.com

Build Status js oceanprotocol Greenkeeper badge



Copy editing

Create a new link by editing the content.yml file. When editing on GitHub, click the pencil icon to start editing the file:

screen shot 2018-11-02 at 11 32 19

Only thing to remember is to keep the indentation as in this example:

links:
    - name: JupyterHub Notebook
      url: https://longurl.com
    - name: Another JupyterHub Notebook
      url: https://longurl.com

This example would result in:

screen shot 2018-12-04 at 14 58 25

Editing workflow

The basic workflow goes like this:

  1. edit the content.yml file
  2. when committing changes, create a new branch and open a pull request
  3. ask for review & approval of pull request
  4. have the pull request merged
screen shot 2018-11-02 at 11 50 14

The master branch is protected from being pushed to, enforcing the following rules:

  • every change has to be done in another branch and go through a pull request against master
  • pull requests need to be reviewed and approved
  • pull requests need to pass the CI status checks
  • pull requests can be merged by a defined list of members only
  • when merged into master, pull request changes are deployed automatically to live

This will then initiate an automatic build & deployment process, and your change should be live within a minute or so.

Development

This repo is a simple page builder utilizing gulp and Liquid templating.

npm i
npm start

Will start a live-reloading local server, reachable under localhost:1337.

Deployment

Page lives in a S3 bucket and deployment happens automatically via Travis based on the rules described in the editing workflow. For that to work, the following environment variables need to be setup in Travis:

  • AWS_DEFAULT_REGION
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

Every master Travis build triggers this script which can also be used for manual emergency deployments:

npm run deploy
# executing ./deploy.sh

DNS for datascience.oceanprotocol.com is setup via Cloudflare, pointing to the S3 bucket under datascience.oceanprotocol.com.s3-website-ap-southeast-1.amazonaws.com

Authors

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.