From 64aae489ddf8348573a5a6b1cd12a413d41111bc Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Mon, 17 Dec 2018 17:18:29 +0100 Subject: [PATCH 1/3] docker-images -> barge --- content/setup/quickstart.md | 8 ++++---- content/test.md | 4 ++-- content/tutorials/get-ether-and-ocean-tokens.md | 6 +++--- content/tutorials/react-setup.md | 2 +- src/components/Repositories/QuickRun.jsx | 4 ++-- src/components/Repositories/index.jsx | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/content/setup/quickstart.md b/content/setup/quickstart.md index a23a15c6..7e545d3a 100644 --- a/content/setup/quickstart.md +++ b/content/setup/quickstart.md @@ -6,8 +6,8 @@ description: Do a quick test drive. You can run and try every [Ocean software component](/concepts/components/) in your local machine, all at once, using Docker Compose: ```bash -git clone https://github.com/oceanprotocol/docker-images.git -cd docker-images/ +git clone https://github.com/oceanprotocol/barge.git +cd barge/ ./start_ocean.sh --latest ``` @@ -22,6 +22,6 @@ Once everything is up and running, you can interact with the components. For exa Note that everything is running on your local machine, including a local Ethereum node, and it's not connected to any external Ethereum network. -For the details of what components are running, see the [Ocean Protocol docker-images repository](https://github.com/oceanprotocol/docker-images). +For the details of what components are running, see the [Ocean Protocol barge repository](https://github.com/oceanprotocol/barge). - + diff --git a/content/test.md b/content/test.md index 728e8307..7310eaef 100644 --- a/content/test.md +++ b/content/test.md @@ -130,8 +130,8 @@ Inline `code` has `back-ticks around` it. Blocks of code are either fenced by lines with three back-ticks, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting. ```bash -git clone https://github.com/oceanprotocol/docker-images.git -cd docker-images/ +git clone https://github.com/oceanprotocol/barge.git +cd barge/ ./start_ocean.sh --latest ``` diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 423bd2f2..f4015bb7 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -34,7 +34,7 @@ If you're running a local Ganache-based testnet, then it creates several account ### Get Ether for a Local Parity-Ethereum-Based Testnet -If you're running a local Parity-Ethereum-based testnet based on [docker-images](https://github.com/oceanprotocol/docker-images), then you can send some Ether to `` using the command: +If you're running a local Parity-Ethereum-based testnet based on [barge](https://github.com/oceanprotocol/barge), then you can send some Ether to `` using the command: ```bash curl --data '{"jsonrpc":"2.0","method":"personal_sendTransaction","params":[{"from":"0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e","to":"","value":"0x7FFFFFFFFFFFFFFFFFF"}, "node0"],"id":0}' -H "Content-Type: application/json" -X POST localhost:8545 @@ -46,6 +46,6 @@ That command uses [Ethereum's JSON RPC API](https://wiki.parity.io/JSONRPC.html) One way to get some Ocean Tokens, for the network you're connected to, is by running Pleuston (a demo Ocean marketplace web app) and then clicking in the top right corner of the Pleuston user interface. If you see "Make it rain" then click that. -Running Pleuston, along with all the software it needs to work, is beyond the scope of this tutorial. If you want to do _that_, then the current best option is to use the scripts and Docker Compose files in the [🐳 docker-images repository](https://github.com/oceanprotocol/docker-images). +Running Pleuston, along with all the software it needs to work, is beyond the scope of this tutorial. If you want to do _that_, then the current best option is to use the scripts and Docker Compose files in the [🐳 barge repository](https://github.com/oceanprotocol/barge). - + diff --git a/content/tutorials/react-setup.md b/content/tutorials/react-setup.md index c7e9def3..dc5e8f8f 100644 --- a/content/tutorials/react-setup.md +++ b/content/tutorials/react-setup.md @@ -9,7 +9,7 @@ description: This tutorial shows how you can build a basic [React](https://react - `npm` >= 5.2 is installed. You can check using `npm -v` - Do the tutorial to [Set Up Azure Storage](/tutorials/azure-for-brizo/). - Use a browser with [MetaMask](https://metamask.io/) and some Ether in your account. See the tutorial about [getting Ether and Ocean Tokens for testnets](/tutorials/get-ether-and-ocean-tokens/). -- Git clone the [oceanprotocol/docker-images](https://github.com/oceanprotocol/docker-images) repository, then in that directory: +- Git clone the [oceanprotocol/barge](https://github.com/oceanprotocol/barge) repository, then in that directory: - Edit the `brizo.env` file and set all `AZURE_`... values. - Run `./start_ocean.sh --no-pleuston --local-kovan-node`. This runs several Ocean services locally, including a local Parity Ethereum node connected to the Kovan Testnet. diff --git a/src/components/Repositories/QuickRun.jsx b/src/components/Repositories/QuickRun.jsx index 5d651bc7..93cbc8f3 100644 --- a/src/components/Repositories/QuickRun.jsx +++ b/src/components/Repositories/QuickRun.jsx @@ -19,9 +19,9 @@ const QuickRun = ({ name }) => (
                 
                     git clone
-                    https://github.com/oceanprotocol/docker-images.git
+                    https://github.com/oceanprotocol/barge.git
                     
- cd docker-images/ + cd barge/

./start_ocean.sh --latest diff --git a/src/components/Repositories/index.jsx b/src/components/Repositories/index.jsx index bd60c7a8..d52881d5 100644 --- a/src/components/Repositories/index.jsx +++ b/src/components/Repositories/index.jsx @@ -32,7 +32,7 @@ const Repositories = () => ( return (
- +

From f986aa312f599f08b222c1aec718ce967c768b8a Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 18 Dec 2018 10:56:43 +0100 Subject: [PATCH 2/3] Add link & explanation of Jupyter notebook tuts --- content/concepts/tools.md | 8 +++----- content/tutorials/introduction.md | 9 ++------- content/tutorials/jupyter-notebooks.md | 17 +++++++++++++++++ data/sidebars/tutorials.yml | 7 ++++++- 4 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 content/tutorials/jupyter-notebooks.md diff --git a/content/concepts/tools.md b/content/concepts/tools.md index d30f6837..dec716c1 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -3,20 +3,18 @@ title: Tools & Examples description: Tools and examples for developing with Ocean Protocol. --- -The Setup & Tutorials sections have some examples to get you started. - -- [Setup: Quick Start](/setup/quickstart/) -- [Tutorials: Introduction](/tutorials/introduction/) - ## Tools Coming soon! ## Examples +The [Tutorials](/tutorials/introduction/) include many examples. + Examples of using the [🦑 squid-py](https://github.com/oceanprotocol/squid-js) Python library: + Examples of using the [🦑 squid-js](https://github.com/oceanprotocol/squid-js) JavaScript library: diff --git a/content/tutorials/introduction.md b/content/tutorials/introduction.md index 52b4fc23..5cc2c6b5 100644 --- a/content/tutorials/introduction.md +++ b/content/tutorials/introduction.md @@ -3,14 +3,9 @@ title: Overview of the Tutorials description: What you can expect to find in these Ocean Protocol tutorials. --- -These tutorials give examples of how to use squid-js (JavaScript) and squid-py (Python) to: +The idea of these tutorials is to show you how to use squid-js (JavaScript) and squid-py (Python) to: - publish a data set -- publish a compute service - get and use a data set +- publish a compute service - get and use a compute service - -The Python tutorials use [Jupyter notebooks](http://jupyter.org/). -For now, check out [the Mantaray repository](https://github.com/oceanprotocol/mantaray). In the future, we hope to have live online Jupyter notebooks. - - diff --git a/content/tutorials/jupyter-notebooks.md b/content/tutorials/jupyter-notebooks.md new file mode 100644 index 00000000..fb9e3b17 --- /dev/null +++ b/content/tutorials/jupyter-notebooks.md @@ -0,0 +1,17 @@ +--- +title: Jupyter Notebooks +description: Try some online interactive squid-py tutorials. +--- + +You can go through interactive squid-py tutorials at [datascience.oceanprotocol.com](https://datascience.oceanprotocol.com/). +They're [Jupyter Notebooks](http://jupyter.org/) running on your own [JupyterLab](https://github.com/jupyterlab/jupyterlab) instance. +It's quite easy to figure out, but if you get stuck, here are some initial steps: + +- Visit [datascience.oceanprotocol.com](https://datascience.oceanprotocol.com/). +- Click the **JupyterLab Instance** button. +- Login with your GitHub account. +- Once you're in the JupyterLab console, double-click on **mantaray_jupyter**. +- Double-click on **introdution.txt** and read it. +- Double-click on one of the **.ipynb** files. They're labelled to appear in a logical order. +- When asked to select a kernel, select Python 3. +- To make stuff happen (e.g. to run code cells), use the menus at the top of the JupyterLab console, or at the top of your current Jupyter notebook. diff --git a/data/sidebars/tutorials.yml b/data/sidebars/tutorials.yml index 0815ebaa..50ffffec 100644 --- a/data/sidebars/tutorials.yml +++ b/data/sidebars/tutorials.yml @@ -7,7 +7,7 @@ - title: Set Up Azure Storage link: /tutorials/azure-for-brizo/ -- group: React App Tutorial +- group: React App Tutorial (squid-js) items: - title: Setup link: /tutorials/react-setup/ @@ -15,3 +15,8 @@ link: /tutorials/react-publish-data-set/ - title: Get & Use a Data Set link: /tutorials/react-get-use-data-set/ + +- group: squid-py Tutorials + items: + - title: Jupyter Notebooks + link: /tutorials/jupyter-notebooks/ From f86ab5d9a009adf7d7bfb4942bd3a598c957813e Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 19 Dec 2018 17:41:22 +0100 Subject: [PATCH 3/3] Add link to the first Manta Ray blog post --- content/tutorials/jupyter-notebooks.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/tutorials/jupyter-notebooks.md b/content/tutorials/jupyter-notebooks.md index fb9e3b17..450f935c 100644 --- a/content/tutorials/jupyter-notebooks.md +++ b/content/tutorials/jupyter-notebooks.md @@ -15,3 +15,5 @@ It's quite easy to figure out, but if you get stuck, here are some initial steps - Double-click on one of the **.ipynb** files. They're labelled to appear in a logical order. - When asked to select a kernel, select Python 3. - To make stuff happen (e.g. to run code cells), use the menus at the top of the JupyterLab console, or at the top of your current Jupyter notebook. + +For more info, see the blog post titled, "[Project Manta Ray — Data Science powered by Ocean Protocol](https://blog.oceanprotocol.com/project-manta-ray-data-science-powered-by-ocean-protocol-535c54089b0f)."