From 3b73a3ba9676401b8aa7478661f5474b6ea1bb43 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 16 Jan 2019 16:28:11 +0100 Subject: [PATCH 1/7] Add links to more Squid code examples --- content/concepts/tools.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/concepts/tools.md b/content/concepts/tools.md index dec716c1..123f665c 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -11,12 +11,12 @@ Coming soon! 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-py](https://github.com/oceanprotocol/squid-js) Python library can be found in the [squid_py/examples/ directory of the squid-py repository](https://github.com/oceanprotocol/squid-py/tree/develop/squid_py/examples). More examples are in the repositories: -Examples of using the [🦑 squid-js](https://github.com/oceanprotocol/squid-js) JavaScript library: +Examples of using the [🦑 squid-js](https://github.com/oceanprotocol/squid-js) JavaScript library can be found in the [src/examples/ directory of the squid-js repository](https://github.com/oceanprotocol/squid-js/tree/develop/src/examples). More examples are in the repositories: From 8d32f36298407467cf086919e7b90776b786a4a3 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 21 Jan 2019 12:07:17 +0100 Subject: [PATCH 2/7] Update README: API & Library Reference docs now exist --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 48946997..4770b5ee 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ The documentation is split in multiple sections whose content lives in this repo - **Core concepts**: high-level explanation of concepts, assumptions, and components - **Setup**: getting started for various stakeholders and use cases - **Tutorials**: detailed tutorials +- **API & Library References**: docs for the Aquarius & Brizo REST APIs, and docs for various Squid libraries Those sections are defined in the [`/data/sections.yml`](data/sections.yml) file. @@ -66,7 +67,7 @@ Some global values used throughout the site can be set in [`config.js`](config.j Additionally, some content files live in other repositories and are maintained there. They are pulled into Gatsby's data layer at build time, and pages are created automatically for them as defined in [gatsby-node.js](gatsby-node.js). -At the moment, this is setup for the following repositories: +At the moment, this is set up for the following repositories: - [dev-ocean](https://github.com/oceanprotocol/dev-ocean) @@ -74,12 +75,6 @@ For including a document from any of the above repositories, 4 values are requir This will NOT include this page in the doc's sidebar navigation, this needs to be done manually in the docs repo in one of the sidebar files. This is so you can check out everything before exposing it to visitors, and to ensure editorial workflow of the categorization. -TODO: In a later stage, we will include more documentation in this site, e.g.: - -- API references -- Component docs -- Maybe more - ### Markdown File Requirements All Markdown files should use From 8dde335419b72be4ca7fb2008941b037d4848484 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 21 Jan 2019 12:40:31 +0100 Subject: [PATCH 3/7] rm homepage quickstart & fix Quickstart page --- content/setup/quickstart.md | 8 +++++--- src/components/Repositories/index.jsx | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/content/setup/quickstart.md b/content/setup/quickstart.md index 7e545d3a..ca8cc2f3 100644 --- a/content/setup/quickstart.md +++ b/content/setup/quickstart.md @@ -3,7 +3,11 @@ title: Quickstart 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: +You can run and try every [Ocean software component](/concepts/components/) in your local machine, all at once, using Docker Compose. + +First, you must [set up some storage on Azure](/tutorials/azure-for-brizo/). (Yes, we know that's not quick. Some day there will be a local storage option and then this really will be quick.) + +Then: ```bash git clone https://github.com/oceanprotocol/barge.git @@ -20,8 +24,6 @@ Once everything is up and running, you can interact with the components. For exa [http://localhost:3000/](http://localhost:3000/) -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 barge repository](https://github.com/oceanprotocol/barge). diff --git a/src/components/Repositories/index.jsx b/src/components/Repositories/index.jsx index d52881d5..93712c9e 100644 --- a/src/components/Repositories/index.jsx +++ b/src/components/Repositories/index.jsx @@ -32,7 +32,7 @@ const Repositories = () => ( return (
- + {/* */}

From 178eeb2dfe332477b0e493b7e6ba0f92bdd44b2b Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 21 Jan 2019 12:58:19 +0100 Subject: [PATCH 4/7] Comment more QuickRun stuff to make linter happy --- src/components/Repositories/QuickRun.jsx | 2 ++ src/components/Repositories/index.jsx | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/components/Repositories/QuickRun.jsx b/src/components/Repositories/QuickRun.jsx index 93cbc8f3..c2a5f1d0 100644 --- a/src/components/Repositories/QuickRun.jsx +++ b/src/components/Repositories/QuickRun.jsx @@ -1,3 +1,4 @@ +/* import React from 'react' import PropTypes from 'prop-types' import { Link } from 'gatsby' @@ -38,3 +39,4 @@ QuickRun.propTypes = { } export default QuickRun +*/ diff --git a/src/components/Repositories/index.jsx b/src/components/Repositories/index.jsx index 93712c9e..a8d45321 100644 --- a/src/components/Repositories/index.jsx +++ b/src/components/Repositories/index.jsx @@ -1,7 +1,7 @@ import React from 'react' import { Link, StaticQuery, graphql } from 'gatsby' import RepositoryList from './RepositoryList' -import QuickRun from './QuickRun' +// import QuickRun from './QuickRun' import styles from './index.module.scss' const query = graphql` From ef72345f63bdc01485f22b436f53f5ce7b9b6579 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 21 Jan 2019 14:12:21 +0100 Subject: [PATCH 5/7] Add Manta Ray as an option in the Quickstart page --- content/setup/quickstart.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/setup/quickstart.md b/content/setup/quickstart.md index ca8cc2f3..bbec90cc 100644 --- a/content/setup/quickstart.md +++ b/content/setup/quickstart.md @@ -3,6 +3,12 @@ title: Quickstart description: Do a quick test drive. --- +## Option 1 + +You can [try some free, online Jupyter notebooks](/tutorials/jupyter-notebooks/) that connect to a live Ocean test network. + +## Option 2 + You can run and try every [Ocean software component](/concepts/components/) in your local machine, all at once, using Docker Compose. First, you must [set up some storage on Azure](/tutorials/azure-for-brizo/). (Yes, we know that's not quick. Some day there will be a local storage option and then this really will be quick.) From a9f49fe7f96fc8489baebb7085c76f07b3142b9b Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 22 Jan 2019 12:09:49 +0100 Subject: [PATCH 6/7] In Terminology page, add link to Wallets page --- content/concepts/terminology.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/concepts/terminology.md b/content/concepts/terminology.md index 2bcf3d49..50f72397 100644 --- a/content/concepts/terminology.md +++ b/content/concepts/terminology.md @@ -39,4 +39,5 @@ We published an [Ocean Protocol blog post that explains SEAs in more detail](htt ## More Terminology -See the page about Ocean's [Software Components](/concepts/components/). +- See [the page about Ocean's Software Components](/concepts/components/). +- See [the page about wallets (and other Ethereum terminology)](/tutorials/wallets/). From 16d3ea086260857a1b93ea5703f7a0d150b15b82 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 22 Jan 2019 14:55:41 +0100 Subject: [PATCH 7/7] Update all submodules --- external/dev-ocean | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/external/dev-ocean b/external/dev-ocean index 95831642..79786228 160000 --- a/external/dev-ocean +++ b/external/dev-ocean @@ -1 +1 @@ -Subproject commit 958316426a441f34d05a2240806577008713b5a7 +Subproject commit 79786228757f8e39092d9dd5adf387097f0b02f6