1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-06-23 01:36:27 +02:00

Merge branch 'master' into feature/#45-squid-js-docs

This commit is contained in:
Matthias Kretschmann 2019-01-22 14:27:50 +01:00 committed by GitHub
commit 95b1aba1f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 21 additions and 15 deletions

View File

@ -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

View File

@ -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/).

View File

@ -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:
<repo name="mantaray"></repo>
<repo name="tuna"></repo>
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:
<repo name="pleuston"></repo>
<repo name="tuna"></repo>

View File

@ -3,7 +3,17 @@ 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:
## 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.)
Then:
```bash
git clone https://github.com/oceanprotocol/barge.git
@ -20,8 +30,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).
<repo name="barge"></repo>

View File

@ -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
*/

View File

@ -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`
@ -32,7 +32,7 @@ const Repositories = () => (
return (
<div className={styles.repositories}>
<QuickRun name="barge" />
{/* <QuickRun name="barge" /> */}
<header>
<h1 className={styles.repositoriesTitle}>