1
0
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:
Matthias Kretschmann 2018-11-09 20:23:24 +01:00
parent fe621e527c
commit 28ad87ded1
Signed by: m
GPG Key ID: 606EEEF3C479A91F
20 changed files with 96 additions and 92 deletions

View File

@ -3,7 +3,7 @@ title: Architecture
description: The architecture of Ocean Protocol with all its components and how they work together. 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) - [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts)
- [🐋 aquarius](https://github.com/oceanprotocol/aquarius) - [🐋 aquarius](https://github.com/oceanprotocol/aquarius)

View 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)

View File

@ -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-js](https://github.com/oceanprotocol/squid-js)
- [🦑 squid-py](https://github.com/oceanprotocol/squid-py) - [🦑 squid-py](https://github.com/oceanprotocol/squid-py)
- [🦑 squid-java](https://github.com/oceanprotocol/squid-java) - [🦑 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
```

View File

@ -18,7 +18,7 @@ By bringing together decentralized blockchain technology, a data sharing framewo
## Papers ## Papers
There are more details on the 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: and in the whitepapers:
- [Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf) - [Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)

View File

@ -29,3 +29,7 @@ where the associated blockchain network is running the Ocean Protocol
## Secret Store ## Secret Store
[Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval. [Parity Secret Store](https://wiki.parity.io/Secret-Store): software for distributed key pair generation, distributed key storage, and threshold retrieval.
## Ocean network
...

View File

@ -28,15 +28,6 @@ For more complete info, see [John Gruber's original spec](http://daringfireball.
### H3 ### H3
#### H4 #### H4
##### H5 ##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
``` ```
# H1 # H1
@ -44,15 +35,6 @@ Alt-H2
### H3 ### H3
#### H4 #### H4
##### H5 ##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
## Emphasis ## Emphasis
@ -145,26 +127,13 @@ Some text to show that the reference links can follow later.
## Images ## Images
``` ```
Here's our jellyfish (hover to see the title text): ![alt text](jellyfish-grid@2x.png "Ocean Protocol Jellyfish")
Inline-style:
![alt text](https://github.com/oceanprotocol/art/raw/master/jellyfish/jellyfish-grid%402x.png "Ocean Protocol Jellyfish")
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: ![alt text](../node_modules/@oceanprotocol/art/jellyfish/jellyfish-grid@2x.png "Ocean Protocol Jellyfish")
![alt text](https://github.com/oceanprotocol/art/raw/master/jellyfish/jellyfish-grid%402x.png "Ocean Protocol Jellyfish")
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 ## Code and Syntax Highlighting

View File

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

View File

@ -3,59 +3,34 @@
- name: keeper-contracts - name: keeper-contracts
description: '💧 Integration of TCRs, CPM and Ocean Tokens in Solidity' description: '💧 Integration of TCRs, CPM and Ocean Tokens in Solidity'
links: links:
- name: GitHub
url: https://github.com/oceanprotocol/keeper-contracts
- name: Documentation - name: Documentation
url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc
- name: aquarius - name: aquarius
description: '🐋 Off-chain database store for data assets metadata.' description: '🐋 Off-chain database store for data assets metadata.'
links: links:
- name: GitHub
url: https://github.com/oceanprotocol/aquarius
- name: API reference - name: API reference
url: https://github.com/oceanprotocol/aquarius/blob/develop/docs/for_api_users/API.md url: https://github.com/oceanprotocol/aquarius/blob/develop/docs/for_api_users/API.md
- name: brizo - name: brizo
description: 'Helping publishers to expose their services' description: 'Helping publishers to expose their services'
links:
- name: GitHub
url: https://github.com/oceanprotocol/brizo
- name: pleuston - name: pleuston
description: '🦄 Web app for consumers to explore, download, and publish data assets.' description: '🦄 Web app for consumers to explore, download, and publish data assets.'
links:
- name: GitHub
url: https://github.com/oceanprotocol/pleuston
- group: Libraries - group: Libraries
items: items:
- name: squid-js - name: squid-js
description: '🦑 JavaScript client library for Ocean Protocol' description: '🦑 JavaScript client library for Ocean Protocol'
links:
- name: GitHub
url: https://github.com/oceanprotocol/squid-js
- name: squid-py - name: squid-py
description: '🦑 Python client library for Ocean Protocol' description: '🦑 Python client library for Ocean Protocol'
links:
- name: GitHub
url: https://github.com/oceanprotocol/squid-py
- name: squid-java - name: squid-java
description: '🦑 Java client library for Ocean Protocol' description: '🦑 Java client library for Ocean Protocol'
links:
- name: GitHub
url: https://github.com/oceanprotocol/squid-java
- name: secret-store-client-js - name: secret-store-client-js
description: '🔑 JavaScript implementation of the parity secret store for use in ocean.' 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 - name: secret-store-client-py
description: '🔑 Parity Secret Store Python Client' description: '🔑 Parity Secret Store Python Client'
links:
- name: GitHub
url: https://github.com/oceanprotocol/secret-store-client-py

View File

@ -21,9 +21,11 @@
- group: Roadmap - group: Roadmap
items: items:
- title: Development & Governance - title: Development
link: /concepts/development/ link: /concepts/development/
- title: Contributing - title: Contributing
link: /concepts/contributing/ link: /concepts/contributing/
- title: Bounties
link: /concepts/bounties/
- title: Code of Conduct - title: Code of Conduct
link: /concepts/code-of-conduct/ link: /concepts/code-of-conduct/

View File

@ -27,6 +27,14 @@ module.exports = {
path: `${__dirname}/data` path: `${__dirname}/data`
} }
}, },
{
resolve: 'gatsby-source-filesystem',
options: {
name: 'art',
path: `${__dirname}/node_modules/@oceanprotocol/art`
}
},
{ {
resolve: 'gatsby-transformer-remark', resolve: 'gatsby-transformer-remark',
options: { options: {

View File

@ -5,7 +5,6 @@
background-size: cover; background-size: cover;
width: 100%; width: 100%;
padding: $spacer / 2 0; padding: $spacer / 2 0;
padding-right: $spacer / 1.5;
} }
.headerContent { .headerContent {
@ -18,7 +17,6 @@
.headerLogo { .headerLogo {
display: flex; display: flex;
align-items: center; align-items: center;
width: 50%;
cursor: pointer; cursor: pointer;
&:hover, &:hover,
@ -36,9 +34,9 @@
} }
.headerTitle { .headerTitle {
font-size: $font-size-h4; font-size: $font-size-h3;
color: $brand-white; color: $brand-grey-light;
margin-left: $spacer; margin-left: $spacer / 2;
display: none; display: none;
@media (min-width: $break-point--small) { @media (min-width: $break-point--small) {
@ -54,7 +52,11 @@
display: inline-block; display: inline-block;
margin: 0 $spacer / 2; margin: 0 $spacer / 2;
font-family: $font-family-button; font-family: $font-family-button;
color: $brand-grey-light; color: $brand-grey-lighter;
&:last-child {
margin-right: 0;
}
&:hover, &:hover,
&:focus { &:focus {

View File

@ -7,7 +7,7 @@
.headerSectionTitle { .headerSectionTitle {
margin: 0; margin: 0;
font-size: $font-size-h4; font-size: $font-size-h3;
color: $brand-grey-light; color: $brand-grey-light;
} }

View File

@ -8,11 +8,15 @@ const Repository = ({ name, description, links }) => (
<p>{description}</p> <p>{description}</p>
<ul className={styles.repositoryLinks}> <ul className={styles.repositoryLinks}>
{links.map(link => ( <li>
<li key={link.url}> <a href={`https://github.com/oceanprotocol/${name}`}>GitHub</a>
<a href={link.url}>{link.name}</a> </li>
</li> {links &&
))} links.map(link => (
<li key={link.url}>
<a href={link.url}>{link.name}</a>
</li>
))}
</ul> </ul>
</div> </div>
) )

View File

@ -4,7 +4,7 @@
padding: $spacer / $line-height; padding: $spacer / $line-height;
border: 1px solid $brand-grey-lighter; border: 1px solid $brand-grey-lighter;
border-radius: $border-radius; border-radius: $border-radius;
margin-bottom: 5%; margin-bottom: 4%;
@media (min-width: $break-point--small) { @media (min-width: $break-point--small) {
flex: 0 0 100%; flex: 0 0 100%;
@ -19,12 +19,12 @@
.repositoryLinks { .repositoryLinks {
margin: 0; margin: 0;
padding: 0; padding: 0;
margin-left: -($spacer / 2); margin-left: -($spacer / $line-height);
li { li {
display: inline-block; display: inline-block;
padding: 0; padding: 0;
margin-left: $spacer / 2; margin-left: $spacer / $line-height;
&:before { display: none; } &:before { display: none; }
} }

View File

@ -10,7 +10,7 @@
.repositoryList { .repositoryList {
@media (min-width: $break-point--medium) { @media (min-width: $break-point--medium) {
flex: 0 0 45%; flex: 0 0 48%;
} }
} }
@ -23,6 +23,6 @@
} }
.repositoryListTitle { .repositoryListTitle {
font-size: $font-size-h4; font-size: $font-size-h3;
color: $brand-grey-light; color: $brand-grey-light;
} }

View File

@ -1,17 +1,19 @@
import React from 'react' import React from 'react'
import { StaticQuery, graphql } from 'gatsby' import { StaticQuery, graphql, Link } from 'gatsby'
import RepositoryList from './RepositoryList' import RepositoryList from './RepositoryList'
import styles from './index.module.scss' import styles from './index.module.scss'
const QuickRun = () => ( const QuickRun = () => (
<div className={styles.quickrun}> <div className={styles.quickrun}>
<strong className={styles.tldr}>TL;DR</strong>
<strong> <strong>
Wanna quickly get an Ocean network with all core components running Wanna quickly get an Ocean network with all{' '}
on your machine? Check out{' '} <Link to="/concepts/ecosystem/">core components</Link> running on
your machine? Check out{' '}
<a href="https://github.com/oceanprotocol/docker-images"> <a href="https://github.com/oceanprotocol/docker-images">
🐳 docker-images 🐳 docker-images
</a> </a>
. :
</strong> </strong>
<pre className="language-bash"> <pre className="language-bash">
<code className="language-bash"> <code className="language-bash">

View File

@ -5,7 +5,7 @@
} }
.quickrun { .quickrun {
padding-top: $spacer * 2; padding-top: $spacer;
padding-bottom: $spacer; padding-bottom: $spacer;
text-align: center; text-align: center;
max-width: $break-point--small; max-width: $break-point--small;
@ -16,3 +16,10 @@
margin-top: $spacer / $line-height; margin-top: $spacer / $line-height;
} }
} }
.tldr {
display: block;
margin-bottom: $spacer / 2;
color: $brand-grey-light;
font-size: $font-size-h4;
}

View File

@ -26,7 +26,7 @@ $font-family-monospace: 'Fira Code', 'Fira Mono', Menlo, Monaco, Consolas,
$font-size-root: 15px; $font-size-root: 15px;
$font-size-base: 1rem; $font-size-base: 1rem;
$font-size-large: 1.25rem; $font-size-large: 1.2rem;
$font-size-small: .85rem; $font-size-small: .85rem;
$font-size-mini: .65rem; $font-size-mini: .65rem;
$font-size-text: $font-size-base; $font-size-text: $font-size-base;
@ -34,9 +34,9 @@ $font-size-label: $font-size-base;
$font-size-title: 1.4rem; $font-size-title: 1.4rem;
$font-size-h1: 3rem; $font-size-h1: 3rem;
$font-size-h2: 1.7rem; $font-size-h2: 1.7rem;
$font-size-h3: 1.5rem; $font-size-h3: 1.4rem;
$font-size-h4: 1.25rem; $font-size-h4: $font-size-large;
$font-size-h5: 1.125rem; $font-size-h5: 1.1rem;
$font-weight-base: 500; $font-weight-base: 500;
$font-weight-bold: 600; $font-weight-bold: 600;

View File

@ -31,7 +31,7 @@ export default class DocTemplate extends Component {
return ( return (
<Layout location={location}> <Layout location={location}>
<HeaderSection title={sectionTitle} /> <HeaderSection title={section ? sectionTitle : title} />
<Content> <Content>
{section ? ( {section ? (

View File

@ -42,6 +42,7 @@
overflow-wrap: break-word; overflow-wrap: break-word;
word-wrap: break-word; word-wrap: break-word;
word-break: break-word; word-break: break-word;
padding-bottom: $spacer / $line-height;
figcaption { figcaption {
font-size: $font-size-small; font-size: $font-size-small;
@ -51,7 +52,9 @@
} }
h1, h2 { h1, h2 {
margin-top: $spacer; margin-top: $spacer * $line-height;
margin-bottom: $spacer; margin-bottom: $spacer / $line-height;
padding-bottom: $spacer / $line-height;
border-bottom: 1px solid $brand-grey-lighter;
} }
} }