mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge pull request #16 from oceanprotocol/feature/docs-edits-nov-12-13
Got Core Concepts in good shape, some edits to markeplaces
This commit is contained in:
Troy McConaghy
GitHub
commit
f54f714c49
@ -3,9 +3,9 @@ title: Bounties
|
||||
description: Help with Ocean Protocol development and have Ocean Tokens rain on you.
|
||||
---
|
||||
|
||||
Explain our bounties
|
||||
Check out the:
|
||||
|
||||
- [Ocean Protocol Bounties on Gitcoin](https://gitcoin.co/profile/oceanprotocol)
|
||||
- [Ocean Protocol Bounties on bounties.network](https://explorer.bounties.network/explorer?bountyStage=active&search=ocean%20protocol)
|
||||
|
||||
<repo name="ocean-bounties"></repo>
|
||||
|
||||
- [Gitcoin](https://gitcoin.co/profile/oceanprotocol)
|
||||
- [bounties.network](https://explorer.bounties.network/explorer?bountyStage=active&search=ocean%20protocol)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: If you would like to contribute to Ocean Protocol, you have different possibilities.
|
||||
title: Ways to Contribute
|
||||
description: There are many ways you could contribute to Ocean Protocol.
|
||||
---
|
||||
|
||||
All contributions to Ocean Protocol are governed by our [Code of Conduct](code-of-conduct/).
|
||||
All contributions to Ocean Protocol are governed by our [Code of Conduct](/concepts/code-of-conduct/).
|
||||
|
||||
## Report a Bug
|
||||
|
||||
@ -19,25 +19,28 @@ To make a feature request or proposal, you can go to the [🐙 Ocean Protocol En
|
||||
|
||||
<repo name="OEPs"></repo>
|
||||
|
||||
## Write Docs
|
||||
## Write!
|
||||
|
||||
If you’re writing code, you should also update any related docs. However, you might want to write docs only, such as:
|
||||
You could write articles or blog posts related to Ocean Protocol. Possible topics include:
|
||||
|
||||
- General explainers
|
||||
- Tutorials
|
||||
- Courses
|
||||
- Code explanations
|
||||
- News from recent events
|
||||
- a story about how you used Ocean Protocol or the Ocean network
|
||||
- news from a recent event
|
||||
- tutorials for beginners
|
||||
- a deep dive into some specific aspect of Ocean Protocol
|
||||
- a blog post about a particular component in the Ocean Protocol stack
|
||||
|
||||
For instructions on how to contribute to our main documentation check out the docs repo.
|
||||
For instructions on how to contribute to our main documentation site, check out the docs repo.
|
||||
|
||||
<repo name="docs"></repo>
|
||||
|
||||
## Fix an Issue
|
||||
## Participate in a Bounty
|
||||
|
||||
... Where to look for issues?
|
||||
... With 'help wanted' label?
|
||||
See the page about [bounties](/concepts/bounties/).
|
||||
|
||||
## Participate in a bounty
|
||||
## Help Develop Core Ocean Software
|
||||
|
||||
- [Bounties](/concepts/bounties/)
|
||||
Right now, we're not really set up to accept core code contributions from external developers, except via the bounties mentioned above. In the future, we hope to have policies and processes that empower anyone to contribute.
|
||||
|
||||
If you'd like to follow what the core dev team is doing, a good place to start is the dev-ocean repository on GitHub.
|
||||
|
||||
<repo name="dev-ocean"></repo>
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
---
|
||||
title: Security
|
||||
---
|
||||
@ -3,7 +3,7 @@ title: Terminology
|
||||
description: Terminology specific to Ocean Protocol.
|
||||
---
|
||||
|
||||
## Asset
|
||||
## Asset (or Data Asset)
|
||||
|
||||
A data set or data service.
|
||||
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Reporting vulnerabilities
|
||||
title: Reporting Vulnerabilities
|
||||
description: What to do if you find a security flaw in Ocean software.
|
||||
---
|
||||
|
||||
Sometime after the Trilobite release, we will be setting up an official bug bounty program, but for now, you can responsibly disclose flaws by emailing us at <a href="mailto:security@oceanprotocol.com">security@oceanprotocol.com</a>.
|
||||
|
||||
@ -6,10 +6,11 @@ description: Build and run a data marketplace in the Ocean network.
|
||||
If you want to set up and run a marketplace in the Ocean network, then at a technical level, you must:
|
||||
|
||||
- Build your marketplace application
|
||||
- Run your marketplace application and some Ocean components:
|
||||
- Run:
|
||||
- Your marketplace application
|
||||
- Aquarius
|
||||
- A database for Aquarius
|
||||
- An Ethereum client (e.g. Ganache, Parity Ethereum)
|
||||
- Parity Ethereum
|
||||
- Maybe Brizo, unless you are working with others (publishers) running Brizo
|
||||
- Maybe more?
|
||||
|
||||
@ -17,16 +18,20 @@ We expand on all of that below.
|
||||
|
||||
## Building A Marketplace Application
|
||||
|
||||
An Ocean marketplace application is a web app that lets people list data assets for sale (maybe free) and lets consumers buy those assets. To connect your marketplace with the Ocean network, you'll want to use one of the Squid libraries.
|
||||
An Ocean marketplace application (app) is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what data sets and data services a marketplace has on offer. They can use the marketplace app to buy access to data sets or services.
|
||||
|
||||
TODO: Expand the following:
|
||||
To build an Ocean marketplace application, you will probably want to use one of the Squid software libraries because they simplify working with the Ocean network.
|
||||
Currently there are Squid libraries for JavaScript, Python and Java.
|
||||
As an analogy, squid-py is to Ocean like boto3 is to AWS.
|
||||
|
||||
Dev option 1: Fork Pleuston (serverless). Use the Docker Compose workflow that Pleuston devs use.
|
||||
Dev example 1: Fork Pleuston (serverless). Use the Docker Compose workflow that Pleuston devs use.
|
||||
|
||||
Dev option 2: Build a marketplace with a server-side and a web frontend. Use one of the Squid libraries.
|
||||
Dev example 2: Build a marketplace with a Python server-side (using squid-py) and a web frontend. Use one of the Squid libraries.
|
||||
|
||||
<hr>
|
||||
|
||||
Note that you can probably use Docker Compose or similar to run all the other stuff, for now.
|
||||
|
||||
Old content to scavenge:
|
||||
|
||||
## Pleuston
|
||||
|
||||
@ -9,20 +9,18 @@
|
||||
- title: Architecture
|
||||
link: /concepts/architecture/
|
||||
|
||||
- group: Security
|
||||
- group: Details
|
||||
items:
|
||||
- title: Overview
|
||||
link: /concepts/security/
|
||||
- title: Reporting Vulnerabilities
|
||||
link: /concepts/vulnerabilities/
|
||||
- title: Coming Soon
|
||||
link: /
|
||||
|
||||
- group: Roadmap
|
||||
- group: Contribute
|
||||
items:
|
||||
- title: Development
|
||||
link: /concepts/development/
|
||||
- title: Contributing
|
||||
- title: Ways to Contribute
|
||||
link: /concepts/contributing/
|
||||
- title: Bounties
|
||||
link: /concepts/bounties/
|
||||
- title: Reporting Vulnerabilities
|
||||
link: /concepts/vulnerabilities/
|
||||
- title: Code of Conduct
|
||||
link: /concepts/code-of-conduct/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user