mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
auto generate github links for repos, more content updates
This commit is contained in:
parent
fe621e527c
commit
28ad87ded1
GPG Key ID:
606EEEF3C479A91F
@ -3,7 +3,7 @@ title: Architecture
|
||||
description: The architecture of Ocean Protocol with all its components and how they work together.
|
||||
---
|
||||
|
||||
In the [Ecosystem overview](/concepts/ecosystem/) you got an overview about the components making up the Ocean Protocol network:
|
||||
In the [Ecosystem overview](/concepts/ecosystem/) you learned about the components making up the Ocean Protocol network:
|
||||
|
||||
- [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
|
||||
- [🐋 aquarius](https://github.com/oceanprotocol/aquarius)
|
||||
|
||||
9
content/concepts/bounties.md
Normal file
9
content/concepts/bounties.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Bounties
|
||||
description: Help with Ocean Protocol development and have Ocean Tokens rain on you.
|
||||
---
|
||||
|
||||
Explain our bounties
|
||||
|
||||
- [Gitcoin](https://gitcoin.co/profile/oceanprotocol)
|
||||
- [bounties.network](https://explorer.bounties.network/explorer?bountyStage=active&search=ocean%20protocol)
|
||||
@ -34,3 +34,20 @@ Client libraries used by applications to interact with Ocean nodes, including Ke
|
||||
- [🦑 squid-js](https://github.com/oceanprotocol/squid-js)
|
||||
- [🦑 squid-py](https://github.com/oceanprotocol/squid-py)
|
||||
- [🦑 squid-java](https://github.com/oceanprotocol/squid-java)
|
||||
|
||||
## Docker images
|
||||
|
||||
All of our core components generate Docker images automatically and we provide some handy Docker Compose scripts to help with testing, showcasing, and developing Ocean Protocol.
|
||||
|
||||
- [🐳 docker-images](https://github.com/oceanprotocol/docker-images)
|
||||
|
||||
### Full Ocean network stack
|
||||
|
||||
As a quick start, you can get a fully working Ocean network with all of the core components mentioned above working together:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/oceanprotocol/docker-images.git
|
||||
cd docker-images/
|
||||
|
||||
./start_ocean.sh --latest
|
||||
```
|
||||
|
||||
@ -18,7 +18,7 @@ By bringing together decentralized blockchain technology, a data sharing framewo
|
||||
## Papers
|
||||
|
||||
There are more details on the
|
||||
[Ocean Protocol home page](https://oceanprotocol.com/),
|
||||
[Ocean Protocol home page](https://oceanprotocol.com/#papers),
|
||||
and in the whitepapers:
|
||||
|
||||
- [Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)
|
||||
|
||||
@ -29,3 +29,7 @@ where the associated blockchain network is running the Ocean Protocol
|
||||
## Secret Store
|
||||
|
||||
[Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval.
|
||||
|
||||
## Ocean network
|
||||
|
||||
...
|
||||
|
||||
@ -28,15 +28,6 @@ For more complete info, see [John Gruber's original spec](http://daringfireball.
|
||||
### H3
|
||||
#### H4
|
||||
##### H5
|
||||
###### H6
|
||||
|
||||
Alternatively, for H1 and H2, an underline-ish style:
|
||||
|
||||
Alt-H1
|
||||
======
|
||||
|
||||
Alt-H2
|
||||
------
|
||||
```
|
||||
|
||||
# H1
|
||||
@ -44,15 +35,6 @@ Alt-H2
|
||||
### H3
|
||||
#### H4
|
||||
##### H5
|
||||
###### H6
|
||||
|
||||
Alternatively, for H1 and H2, an underline-ish style:
|
||||
|
||||
Alt-H1
|
||||
======
|
||||
|
||||
Alt-H2
|
||||
------
|
||||
|
||||
## Emphasis
|
||||
|
||||
@ -145,26 +127,13 @@ Some text to show that the reference links can follow later.
|
||||
## Images
|
||||
|
||||
```
|
||||
Here's our jellyfish (hover to see the title text):
|
||||
|
||||
Inline-style:
|
||||
|
||||
|
||||
Reference-style:
|
||||
![alt text][jellyfish]
|
||||
|
||||
[jellyfish]: https://github.com/oceanprotocol/art/raw/master/jellyfish/jellyfish-grid%402x.png "Ocean Protocol Jellyfish"
|
||||
|
||||
```
|
||||
|
||||
Here's our jellyfish (hover to see the title text):
|
||||
Here's our jellyfish, with the title being output as caption:
|
||||
|
||||
Inline-style:
|
||||
|
||||
|
||||
|
||||
Reference-style:
|
||||
![alt text][jellyfish]
|
||||
|
||||
[jellyfish]: https://github.com/oceanprotocol/art/raw/master/jellyfish/jellyfish-grid%402x.png "Ocean Protocol Jellyfish"
|
||||
|
||||
## Code and Syntax Highlighting
|
||||
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Example Jupyter Notebooks to Interact with the Ocean Network
|
||||
title: Use Jupyter Notebooks to interact with the Ocean network
|
||||
---
|
||||
|
||||
For now, check out [the Mantaray repository](https://github.com/oceanprotocol/mantaray). In the future, we hope to have live online Jupyter notebooks.
|
||||
|
||||
- [mantaray](https://github.com/oceanprotocol/mantaray)
|
||||
|
||||
@ -3,59 +3,34 @@
|
||||
- name: keeper-contracts
|
||||
description: '💧 Integration of TCRs, CPM and Ocean Tokens in Solidity'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/keeper-contracts
|
||||
- name: Documentation
|
||||
url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc
|
||||
|
||||
- name: aquarius
|
||||
description: '🐋 Off-chain database store for data assets metadata.'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/aquarius
|
||||
- name: API reference
|
||||
url: https://github.com/oceanprotocol/aquarius/blob/develop/docs/for_api_users/API.md
|
||||
|
||||
- name: brizo
|
||||
description: 'Helping publishers to expose their services'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/brizo
|
||||
|
||||
- name: pleuston
|
||||
description: '🦄 Web app for consumers to explore, download, and publish data assets.'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/pleuston
|
||||
|
||||
- group: Libraries
|
||||
items:
|
||||
- name: squid-js
|
||||
description: '🦑 JavaScript client library for Ocean Protocol'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/squid-js
|
||||
|
||||
- name: squid-py
|
||||
description: '🦑 Python client library for Ocean Protocol'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/squid-py
|
||||
|
||||
- name: squid-java
|
||||
description: '🦑 Java client library for Ocean Protocol'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/squid-java
|
||||
|
||||
- name: secret-store-client-js
|
||||
description: '🔑 JavaScript implementation of the parity secret store for use in ocean.'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/secret-store-client-js
|
||||
|
||||
- name: secret-store-client-py
|
||||
description: '🔑 Parity Secret Store Python Client'
|
||||
links:
|
||||
- name: GitHub
|
||||
url: https://github.com/oceanprotocol/secret-store-client-py
|
||||
|
||||
@ -21,9 +21,11 @@
|
||||
|
||||
- group: Roadmap
|
||||
items:
|
||||
- title: Development & Governance
|
||||
- title: Development
|
||||
link: /concepts/development/
|
||||
- title: Contributing
|
||||
link: /concepts/contributing/
|
||||
- title: Bounties
|
||||
link: /concepts/bounties/
|
||||
- title: Code of Conduct
|
||||
link: /concepts/code-of-conduct/
|
||||
|
||||
@ -27,6 +27,14 @@ module.exports = {
|
||||
path: `${__dirname}/data`
|
||||
}
|
||||
},
|
||||
|
||||
{
|
||||
resolve: 'gatsby-source-filesystem',
|
||||
options: {
|
||||
name: 'art',
|
||||
path: `${__dirname}/node_modules/@oceanprotocol/art`
|
||||
}
|
||||
},
|
||||
{
|
||||
resolve: 'gatsby-transformer-remark',
|
||||
options: {
|
||||
|
||||
@ -5,7 +5,6 @@
|
||||
background-size: cover;
|
||||
width: 100%;
|
||||
padding: $spacer / 2 0;
|
||||
padding-right: $spacer / 1.5;
|
||||
}
|
||||
|
||||
.headerContent {
|
||||
@ -18,7 +17,6 @@
|
||||
.headerLogo {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
width: 50%;
|
||||
cursor: pointer;
|
||||
|
||||
&:hover,
|
||||
@ -36,9 +34,9 @@
|
||||
}
|
||||
|
||||
.headerTitle {
|
||||
font-size: $font-size-h4;
|
||||
color: $brand-white;
|
||||
margin-left: $spacer;
|
||||
font-size: $font-size-h3;
|
||||
color: $brand-grey-light;
|
||||
margin-left: $spacer / 2;
|
||||
display: none;
|
||||
|
||||
@media (min-width: $break-point--small) {
|
||||
@ -54,7 +52,11 @@
|
||||
display: inline-block;
|
||||
margin: 0 $spacer / 2;
|
||||
font-family: $font-family-button;
|
||||
color: $brand-grey-light;
|
||||
color: $brand-grey-lighter;
|
||||
|
||||
&:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
&:hover,
|
||||
&:focus {
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
|
||||
.headerSectionTitle {
|
||||
margin: 0;
|
||||
font-size: $font-size-h4;
|
||||
font-size: $font-size-h3;
|
||||
color: $brand-grey-light;
|
||||
}
|
||||
|
||||
|
||||
@ -8,11 +8,15 @@ const Repository = ({ name, description, links }) => (
|
||||
<p>{description}</p>
|
||||
|
||||
<ul className={styles.repositoryLinks}>
|
||||
{links.map(link => (
|
||||
<li key={link.url}>
|
||||
<a href={link.url}>{link.name}</a>
|
||||
</li>
|
||||
))}
|
||||
<li>
|
||||
<a href={`https://github.com/oceanprotocol/${name}`}>GitHub</a>
|
||||
</li>
|
||||
{links &&
|
||||
links.map(link => (
|
||||
<li key={link.url}>
|
||||
<a href={link.url}>{link.name}</a>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</div>
|
||||
)
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
padding: $spacer / $line-height;
|
||||
border: 1px solid $brand-grey-lighter;
|
||||
border-radius: $border-radius;
|
||||
margin-bottom: 5%;
|
||||
margin-bottom: 4%;
|
||||
|
||||
@media (min-width: $break-point--small) {
|
||||
flex: 0 0 100%;
|
||||
@ -19,12 +19,12 @@
|
||||
.repositoryLinks {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
margin-left: -($spacer / 2);
|
||||
margin-left: -($spacer / $line-height);
|
||||
|
||||
li {
|
||||
display: inline-block;
|
||||
padding: 0;
|
||||
margin-left: $spacer / 2;
|
||||
margin-left: $spacer / $line-height;
|
||||
|
||||
&:before { display: none; }
|
||||
}
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
|
||||
.repositoryList {
|
||||
@media (min-width: $break-point--medium) {
|
||||
flex: 0 0 45%;
|
||||
flex: 0 0 48%;
|
||||
}
|
||||
}
|
||||
|
||||
@ -23,6 +23,6 @@
|
||||
}
|
||||
|
||||
.repositoryListTitle {
|
||||
font-size: $font-size-h4;
|
||||
font-size: $font-size-h3;
|
||||
color: $brand-grey-light;
|
||||
}
|
||||
|
||||
@ -1,17 +1,19 @@
|
||||
import React from 'react'
|
||||
import { StaticQuery, graphql } from 'gatsby'
|
||||
import { StaticQuery, graphql, Link } from 'gatsby'
|
||||
import RepositoryList from './RepositoryList'
|
||||
import styles from './index.module.scss'
|
||||
|
||||
const QuickRun = () => (
|
||||
<div className={styles.quickrun}>
|
||||
<strong className={styles.tldr}>TL;DR</strong>
|
||||
<strong>
|
||||
Wanna quickly get an Ocean network with all core components running
|
||||
on your machine? Check out{' '}
|
||||
Wanna quickly get an Ocean network with all{' '}
|
||||
<Link to="/concepts/ecosystem/">core components</Link> running on
|
||||
your machine? Check out{' '}
|
||||
<a href="https://github.com/oceanprotocol/docker-images">
|
||||
🐳 docker-images
|
||||
</a>
|
||||
.
|
||||
:
|
||||
</strong>
|
||||
<pre className="language-bash">
|
||||
<code className="language-bash">
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
}
|
||||
|
||||
.quickrun {
|
||||
padding-top: $spacer * 2;
|
||||
padding-top: $spacer;
|
||||
padding-bottom: $spacer;
|
||||
text-align: center;
|
||||
max-width: $break-point--small;
|
||||
@ -16,3 +16,10 @@
|
||||
margin-top: $spacer / $line-height;
|
||||
}
|
||||
}
|
||||
|
||||
.tldr {
|
||||
display: block;
|
||||
margin-bottom: $spacer / 2;
|
||||
color: $brand-grey-light;
|
||||
font-size: $font-size-h4;
|
||||
}
|
||||
|
||||
@ -26,7 +26,7 @@ $font-family-monospace: 'Fira Code', 'Fira Mono', Menlo, Monaco, Consolas,
|
||||
|
||||
$font-size-root: 15px;
|
||||
$font-size-base: 1rem;
|
||||
$font-size-large: 1.25rem;
|
||||
$font-size-large: 1.2rem;
|
||||
$font-size-small: .85rem;
|
||||
$font-size-mini: .65rem;
|
||||
$font-size-text: $font-size-base;
|
||||
@ -34,9 +34,9 @@ $font-size-label: $font-size-base;
|
||||
$font-size-title: 1.4rem;
|
||||
$font-size-h1: 3rem;
|
||||
$font-size-h2: 1.7rem;
|
||||
$font-size-h3: 1.5rem;
|
||||
$font-size-h4: 1.25rem;
|
||||
$font-size-h5: 1.125rem;
|
||||
$font-size-h3: 1.4rem;
|
||||
$font-size-h4: $font-size-large;
|
||||
$font-size-h5: 1.1rem;
|
||||
|
||||
$font-weight-base: 500;
|
||||
$font-weight-bold: 600;
|
||||
|
||||
@ -31,7 +31,7 @@ export default class DocTemplate extends Component {
|
||||
|
||||
return (
|
||||
<Layout location={location}>
|
||||
<HeaderSection title={sectionTitle} />
|
||||
<HeaderSection title={section ? sectionTitle : title} />
|
||||
|
||||
<Content>
|
||||
{section ? (
|
||||
|
||||
@ -42,6 +42,7 @@
|
||||
overflow-wrap: break-word;
|
||||
word-wrap: break-word;
|
||||
word-break: break-word;
|
||||
padding-bottom: $spacer / $line-height;
|
||||
|
||||
figcaption {
|
||||
font-size: $font-size-small;
|
||||
@ -51,7 +52,9 @@
|
||||
}
|
||||
|
||||
h1, h2 {
|
||||
margin-top: $spacer;
|
||||
margin-bottom: $spacer;
|
||||
margin-top: $spacer * $line-height;
|
||||
margin-bottom: $spacer / $line-height;
|
||||
padding-bottom: $spacer / $line-height;
|
||||
border-bottom: 1px solid $brand-grey-lighter;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user