mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
update 'Contributions' section
This commit is contained in:
trentmc
parent
ce1e1650de
commit
288b5c01a6
@ -1,10 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: Bounties
|
title: Funding
|
||||||
description: Help with Ocean Protocol development and have Ocean Tokens rain on you.
|
description: Funding available for contributors to Ocean
|
||||||
---
|
---
|
||||||
|
|
||||||
Check out the:
|
Funding can be for contributing to the core software, building apps, doing integrations, fixing bugs, community outreach, and more.
|
||||||
|
|
||||||
- [Ocean Protocol Bounties on Gitcoin](https://gitcoin.co/explorer?network=mainnet&idx_status=open&keywords=oceanprotocol&order_by=-web3_created&org=oceanprotocol)
|
Here are two options for getting funding.
|
||||||
|
|
||||||
<repo name="ocean-bounties"></repo>
|
* You can make a funding proposal [here](https://www.oceanprotocol.com/fund).
|
||||||
|
* Or, go for a pre-defined [bounty on Gitcoin](https://gitcoin.co/explorer?network=mainnet&idx_status=open&keywords=oceanprotocol&order_by=-web3_created&org=oceanprotocol)
|
||||||
@ -1,22 +1,23 @@
|
|||||||
---
|
---
|
||||||
title: Compute-to-Data
|
title: Compute-to-Data
|
||||||
description: How Ocean Protocol enables Publishers to provide computing services and related services.
|
description: Providing access to data in a privacy-preserving fashion
|
||||||
slug: /concepts/compute-to-data/
|
slug: /concepts/compute-to-data/
|
||||||
section: concepts
|
section: concepts
|
||||||
---
|
---
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
The most basic scenario for a Publisher is to provide access to the datasets they own or manage.
|
The most basic scenario for a Publisher is to provide access to the datasets they own or manage. However, a Publisher may offer a service to execute some computation on top of their data. This has some benefits:
|
||||||
In addition to that, a Publisher could offer a service to execute some computation on top of their data. This has some benefits:
|
|
||||||
|
|
||||||
- The data **never** leaves the Publisher enclave.
|
- The data **never** leaves the Publisher enclave.
|
||||||
- It's not necessary to move the data; the algorithm is sent to the data.
|
- It's not necessary to move the data; the algorithm is sent to the data.
|
||||||
- Having only one copy of the data and not moving it makes it easier to be compliant with data protection regulations.
|
- Having only one copy of the data and not moving it makes it easier to be compliant with data protection regulations.
|
||||||
|
|
||||||
|
[This page](https://oceanprotocol.com/technology/compute-to-data) elaborates on the benefits.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
### Enabling Publisher Services (Brizo)
|
### Enabling Publisher Services, using Ocean Provider
|
||||||
|
|
||||||
The direct interaction with the infrastructure where the data resides requires the execution of a component handled by Publishers.
|
The direct interaction with the infrastructure where the data resides requires the execution of a component handled by Publishers.
|
||||||
|
|
||||||
@ -24,26 +25,16 @@ This component will be in charge of interacting with users and managing the basi
|
|||||||
|
|
||||||
The business logic supporting these additional Publisher capabilities is the responsibility of this new technical component.
|
The business logic supporting these additional Publisher capabilities is the responsibility of this new technical component.
|
||||||
|
|
||||||
The main and new key component introduced to support these additional Publisher services is named **Brizo**.
|
The main and new key component introduced to support these additional Publisher services is named **Ocean Provider**.
|
||||||
|
|
||||||
> Brizo is an ancient Greek goddess who was known as the protector of mariners, sailors, and fishermen. She was worshipped primarily by the women of Delos, who set out food offerings in small boats. Brizo was also known as a prophet specializing in the interpretation of dreams.
|
Ocean Provider is the technical component executed by the **Publishers**, which provides extended data services. Ocean Provider includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise).
|
||||||
|
|
||||||
In the Ocean ecosystem, Brizo is the technical component executed by the **Publishers**, which provides extended data services. Brizo, as part of the Publisher ecosystem, includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise).
|
|
||||||
|
|
||||||
Because of these credentials, the execution of Brizo **SHOULD NOT** be delegated to a third-party.
|
|
||||||
|
|
||||||
<repo name="brizo"></repo>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Compute-to-Data Enviroment (Operator-Service)
|
### Compute-to-Data Enviroment (Operator-Service)
|
||||||
|
|
||||||
The Operator Service is a micro-service implementing part of the Ocean Protocol
|
The Operator Service is a micro-service that implements part of the Compute-to-Data spec [OEP-12](https://github.com/oceanprotocol/OEPs/tree/master/12),
|
||||||
[Compute to the Data OEP-12](https://github.com/oceanprotocol/OEPs/tree/master/12),
|
|
||||||
in charge of managing the workflow executing requests.
|
in charge of managing the workflow executing requests.
|
||||||
|
|
||||||
Typically the Operator Service is integrated from the [Brizo proxy](https://github.com/oceanprotocol/brizo),
|
Typically the Operator Service is integrated from Ocean Provider, but can be called independently if it.
|
||||||
but can be called independently if it.
|
|
||||||
|
|
||||||
The Operator Service is in charge of stablishing the communication with the K8s cluster, allowing to:
|
The Operator Service is in charge of stablishing the communication with the K8s cluster, allowing to:
|
||||||
|
|
||||||
@ -81,5 +72,5 @@ In the above diagram you can see the initial integration supported. It involves
|
|||||||
Before the flow can begin, the following pre-conditions must be met:
|
Before the flow can begin, the following pre-conditions must be met:
|
||||||
|
|
||||||
- The Asset DDO has a compute service.
|
- The Asset DDO has a compute service.
|
||||||
- The Asset DDO must specify the Brizo endpoint exposed by the Publisher.
|
- The Asset DDO must specify the Ocean Provider endpoint exposed by the Publisher.
|
||||||
- The Service Agreement template must already be predefined and whitelisted `on-chain`.
|
- The Service Agreement template must already be predefined and whitelisted `on-chain`.
|
||||||
|
|||||||
@ -1,57 +1,34 @@
|
|||||||
---
|
---
|
||||||
title: Ways to Contribute
|
title: Ways to Contribute
|
||||||
description: There are many ways you could contribute to Ocean Protocol.
|
description: Help develop Ocean core software, more
|
||||||
---
|
---
|
||||||
|
|
||||||
All contributions to Ocean Protocol are governed by our [Contributor Code of Conduct](/concepts/code-of-conduct/).
|
### Help develop Ocean core software
|
||||||
Code development follows the [Ocean Engineering Principles](/concepts/principles/).
|
|
||||||
|
|
||||||
## Help Develop Core Ocean Software
|
We'd love to have you help contribute to the Ocean core software! Here are ways to get going:
|
||||||
|
|
||||||
- Read and understand the [legal requirements when contributing code](/concepts/legal-reqs/).
|
- *Just do it:)* Branch from the code, improve it, submit a Pull Request.
|
||||||
- Look through the [dev-ocean repository on GitHub](https://github.com/oceanprotocol/dev-ocean). It summarizes Ocean Protocol software development practices and policies.
|
- Chat with other Ocean developers in [Discord](https://discord.gg/TnXjkR5).
|
||||||
- Ask technical questions in the [Ocean Protocol chatroom on Discord](https://discord.gg/TnXjkR5).
|
- Because of the weird world of intellectual property, before it can go through, we need to follow the [legal requirements](/concepts/legal-reqs/). Please be aware of this.
|
||||||
- Find repository-specific development notes in each repository (usually in the root `README.md` file).
|
- Finally, here's the [Contributor Code of Conduct](/concepts/code-of-conduct/).
|
||||||
|
|
||||||
## Report a Vulnerability
|
### Develop an app or integration, using Ocean as a tool
|
||||||
|
|
||||||
See the page about [reporting vulnerabilities](/concepts/vulnerabilities/).
|
Integrate Ocean at one of its interface points: React hooks, Javascript library, Python library, smart contracts, etc.
|
||||||
|
|
||||||
## Report a Bug or Make a Feature Request
|
Ocean documentation will help. And... you're here:)
|
||||||
|
|
||||||
To report a bug that isn't a vulnerability, or to make a feature request, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions.
|
### Report a bug
|
||||||
|
|
||||||
## Suggest a Change to the Protocol Itself
|
To report a vulnerability, [go here](/concepts/vulnerabilities/).
|
||||||
|
|
||||||
To suggest a change to the Ocean Protocol itself (which is actually a set of protocols), go to the [Ocean Protocol Enhancement Proposals (OEPs)](https://github.com/oceanprotocol/OEPs/) repository and write a proposal, either as an issue or as a pull request.
|
To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions.
|
||||||
|
|
||||||
## Write!
|
### Improve these docs
|
||||||
|
|
||||||
You could write articles or blog posts related to Ocean Protocol. Possible topics include:
|
|
||||||
|
|
||||||
- a story about how you used Ocean Protocol or an 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 site, check out the docs repo.
|
|
||||||
|
|
||||||
|
These docs can always be improved. Here's the repo.
|
||||||
<repo name="docs"></repo>
|
<repo name="docs"></repo>
|
||||||
|
|
||||||
## Participate in a Bounty
|
### Other ways to get involved
|
||||||
|
|
||||||
See the page about [bounties](/concepts/bounties/).
|
Please go to the [Ocean Community Page](www.oceanprotocol.com/community) for more ideas on how to get involved.
|
||||||
|
|
||||||
## Become an Ocean Protocol Ambassador
|
|
||||||
|
|
||||||
- [Read the announcement of the Ocean Protocol Ambassador Program](https://blog.oceanprotocol.com/envoys-of-the-new-data-economy-ocean-protocol-ambassadors-3816a0e63611)
|
|
||||||
- [Read about some ambassadors](https://blog.oceanprotocol.com/an-ambassadors-tale-531401d4452f)
|
|
||||||
- [Apply to become an ambassador](https://oceanprotocol.com/#ambassadors)
|
|
||||||
|
|
||||||
## Develop a Service Integration Driver or Plugin
|
|
||||||
|
|
||||||
- Aquarius currently supports storing metadata in Elasticsearch or MongoDB. Each option is supported by its own "OceanDB driver." You could write a new OceanDB driver to support another database. See [the existing OceanDB repositories for examples](https://github.com/oceanprotocol?utf8=%E2%9C%93&q=oceandb&type=&language=).
|
|
||||||
- Brizo currently supports storing data sets in Azure Storage, Amazon S3 or on-premise. Each option is supported by its own "Osmosis driver." You could write a new Osmosis driver to support another storage provider. See [the existing Osmosis repositories for examples](https://github.com/oceanprotocol?utf8=%E2%9C%93&q=osmosis&type=&language=).
|
|
||||||
- [OEP-11 lists the supported encryption and decryption options](https://github.com/oceanprotocol/OEPs/tree/master/11#encryption-and-decryption) (for encrypting URLs before putting them in the metadata, not data sets themselves). You could add support for another option.
|
|
||||||
- Other kinds of services could also be integrated. If you need help or advice, then email <a href="mailto:info@oceanprotocol.com">info@oceanprotocol.com</a>.
|
|
||||||
|
|||||||
@ -10,8 +10,7 @@ All Ocean Protocol code (software) is licensed under an [Apache 2.0 license](htt
|
|||||||
If you are:
|
If you are:
|
||||||
|
|
||||||
- contributing code to complete a _currently-open_ [Ocean Protocol bounty](/concepts/bounties/) or
|
- contributing code to complete a _currently-open_ [Ocean Protocol bounty](/concepts/bounties/) or
|
||||||
- a _current_ employee of BigchainDB GmbH or
|
- a _current_ employee of BigchainDB GmbH
|
||||||
- a _current_ employee of DEX Pte Ltd
|
|
||||||
|
|
||||||
then there is nothing extra for you to do: licensing is already handled.
|
then there is nothing extra for you to do: licensing is already handled.
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Network - Local
|
title: Network - Local
|
||||||
description: Tools for local deployment
|
description: Tools for development on a local Ethereum network
|
||||||
---
|
---
|
||||||
|
|
||||||
You can deploy Ocean onto Ganache - a local Ethereum "network" that you run on your machine for fast iterations while developing your app.
|
You can deploy Ocean onto Ganache - a local Ethereum "network" that you run on your machine for fast iterations while developing your app.
|
||||||
|
|||||||
@ -23,14 +23,12 @@
|
|||||||
items:
|
items:
|
||||||
- title: Ways to Contribute
|
- title: Ways to Contribute
|
||||||
link: /concepts/contributing/
|
link: /concepts/contributing/
|
||||||
- title: Bounties
|
- title: Get Funding
|
||||||
link: /concepts/bounties/
|
link: /concepts/bounties/
|
||||||
- title: Reporting Vulnerabilities
|
- title: Reporting Vulnerabilities
|
||||||
link: /concepts/vulnerabilities/
|
link: /concepts/vulnerabilities/
|
||||||
- title: Legal Requirements when Contributing Code
|
- title: Legal Requirements when Contributing Code
|
||||||
link: /concepts/legal-reqs/
|
link: /concepts/legal-reqs/
|
||||||
- title: Engineering Principles
|
|
||||||
link: /concepts/principles/
|
|
||||||
- title: Code of Conduct
|
- title: Code of Conduct
|
||||||
link: /concepts/code-of-conduct/
|
link: /concepts/code-of-conduct/
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user