From 47f867b4a1568db2c5f6faaf0d317ca34f477760 Mon Sep 17 00:00:00 2001 From: idiom-bytes Date: Thu, 5 Oct 2023 21:17:39 -0700 Subject: [PATCH] Moving DF user-guides and updating routes to point to new location. --- .gitbook.yaml | 17 ++++++++++++----- rewards/README.md | 17 ++++++++++------- .../user-guides}/README.md | 8 ++++---- .../user-guides}/how-to-challengedf.md | 2 +- .../user-guides}/how-to-claim-rewards.md | 0 .../user-guides}/how-to-delegate.md | 0 .../user-guides}/how-to-estimate-apy.md | 4 ++-- .../user-guides}/how-to-veocean.md | 0 .../user-guides}/how-to-volumedf.md | 0 9 files changed, 29 insertions(+), 19 deletions(-) rename {user-guides/data-farming => rewards/user-guides}/README.md (69%) rename {user-guides/data-farming => rewards/user-guides}/how-to-challengedf.md (96%) rename {user-guides/data-farming => rewards/user-guides}/how-to-claim-rewards.md (100%) rename {user-guides/data-farming => rewards/user-guides}/how-to-delegate.md (100%) rename {user-guides/data-farming => rewards/user-guides}/how-to-estimate-apy.md (87%) rename {user-guides/data-farming => rewards/user-guides}/how-to-veocean.md (100%) rename {user-guides/data-farming => rewards/user-guides}/how-to-volumedf.md (100%) diff --git a/.gitbook.yaml b/.gitbook.yaml index f0d27d2f..532634df 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -61,14 +61,21 @@ redirects: veocean-data-farming/df-background: rewards/df-volumedf.md veocean-data-farming/emissions-apys: rewards/df-emissions-apys.md veocean-data-farming/delegation: rewards/README.md - rewards/veOcean-Data-Farming-Tutorial: user-guides/data-farming/how-to-veocean.md + rewards/veOcean-Data-Farming-Tutorial: rewards/user-guides/how-to-veocean.md api-references: developers/README.md api-references/aquarius-rest-api: developers/aquarius/asset-requests.md api-references/provider-rest-api: developers/provider/general-endpoints.md - user-guides/claim-ocean-rewards: user-guides/data-farming/how-to-claim-ocean-rewards.md - user-guides/get-started-df: user-guides/data-farming/how-to-veocean.md - user-guides/how-to-data-farm: user-guides/data-farming/how-to-volume-df.md - user-guides/how-to-df-estimate-apy: user-guides/data-farming/how-to-estimate-apy.md + user-guides/claim-ocean-rewards: rewards/user-guides/how-to-claim-ocean-rewards.md + user-guides/get-started-df: rewards/user-guides/how-to-veocean.md + user-guides/how-to-veocean: rewards/user-guides/how-to-veocean.md + user-guides/how-to-claim-rewards: rewards/user-guides/how-to-claim-ocean-rewards.md + user-guides/how-to-data-farm: rewards/user-guides/how-to-volume-df.md + user-guides/data-farming/how-to-volume-df: rewards/user-guides/how-to-volume-df.md + user-guides/data-farming/how-to-df-estimate-apy: rewards/user-guides/how-to-estimate-apy.md + user-guides/data-farming/how-to-estimate-apy: rewards/user-guides/how-to-estimate-apy.md + user-guides/data-farming/how-to-challengedf: rewards/user-guides/how-to-challengedf.md + user-guides/data-farming/how-to-delegate: rewards/user-guides/how-to-delegate.md + user-guides/data-farming/README: rewards/user-guides/README.md rewards/df-basic: rewards/df-guides.md rewards/veocean: rewards/df-veocean.md rewards/df-max-out-yield: rewards/df-volumedf.md diff --git a/rewards/README.md b/rewards/README.md index 5c586724..744bf19f 100644 --- a/rewards/README.md +++ b/rewards/README.md @@ -6,23 +6,26 @@ coverY: 0 ## What is Data Farming? -Data Farming is Ocean Protocol's core incentive program that rewards participants to onboard the protocol and create value by using tools that help grow it further. +Data Farming is Ocean Protocol's core incentive program that rewards participants to onboard the protocol and create value by using tools that help grow it further. -Data Farming participants earn OCEAN rewards across 2 main streams **Passive Rewards** and **Active Rewards**. Participants are able to **receive rewards passively, actively, or both** by engaging in a variety of activities. +Data Farming participants earn OCEAN rewards across 2 main streams **Passive Rewards** and **Active Rewards**. Participants are able to **receive rewards passively, actively, or both** by engaging in a variety of activities. -Passive Rewards provides a way for all contributors to participate. +Passive Rewards provides a way for all contributors to participate. -Active Rewards focuses on incentivizing the curation and publishing of high-quality data assets and DataNFTs within the Ocean Ecosystem. +Active Rewards focuses on incentivizing the curation and publishing of high-quality data assets and DataNFTs within the Ocean Ecosystem. -We have used battle-tested contracts that safeguard billions (veCRV). With this model there is no liquidity risk. You can’t lose your OCEAN through Impermanent-Loss (IL). It is merely locked. +We have used battle-tested contracts that safeguard billions (veCRV). With this model there is no liquidity risk. You can’t lose your OCEAN through Impermanent-Loss (IL). It is merely locked. ## Introduction -[Farming 101](df-intro.md) introduces Data Farming, the various reward systems, how they work, and how to access them. By the end of the document, you should feel more familiar with Data Farming concepts and having a better idea of what subject you might want to learn about next. +[Farming 101](df-intro.md) introduces Data Farming, the various reward systems, how they work, and how to access them. By the end of the document, you should feel more familiar with Data Farming concepts and having a better idea of what subject you might want to learn about next. + +## User Guides +If you are looking for step-by-step tutorials on how to access the Data Farming program and complete different actions, head over to the Data Farming [User Guides page](user-guides/README.md). ## veOCEAN -Learning about [veOCEAN](df-veocean.md) will help you answer the question "What is the purpose of veOCEAN?" and give insights on how veOCEAN (vote-escrowed OCEAN) is used inside of Ocean Protocol to help advance the protocol. +Learning about [veOCEAN](df-veocean.md) will help you answer the question "What is the purpose of veOCEAN?" and give insights on how veOCEAN (vote-escrowed OCEAN) is used inside of Ocean Protocol to help advance the protocol. It may help for you to review the user guide on [how to estimate APY](../user-guides/data-farming/how-to-estimate-apy.md) to get a better idea for how long you'll want to lock your funds. diff --git a/user-guides/data-farming/README.md b/rewards/user-guides/README.md similarity index 69% rename from user-guides/data-farming/README.md rename to rewards/user-guides/README.md index c8563c27..ec36224d 100644 --- a/user-guides/data-farming/README.md +++ b/rewards/user-guides/README.md @@ -20,19 +20,19 @@ Anyone is welcomed to participate. ## Passive Rewards stream -The primary objective of the [Passive Rewards](../../rewards/df-intro.md#what-are-passive-rewards) stream is to provide an accessible way for anyone to use OCEAN and help the protocol grow. +The primary objective of the [Passive Rewards](../df-intro.md#what-are-passive-rewards) stream is to provide an accessible way for anyone to use OCEAN and help the protocol grow. In [the veOCEAN user guide](how-to-veocean.md), you'll learn more about the Passive Rewards stream and how to get veOCEAN. ## Active Rewards stream & Substreams -The primary objective of [Active Rewards](../../rewards/df-intro.md#what-are-active-rewards) and substreams is to provide participants that engage with Data Farming different opportunities to create value. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol. +The primary objective of [Active Rewards](../df-intro.md#what-are-active-rewards) and substreams is to provide participants that engage with Data Farming different opportunities to create value. This approach allows users with different skills and interests to collaborate and contribute their unique abilities towards achieving the core values of Ocean Protocol. Let's review the Active Reward substreams and get you started. ### Volume DF Substream -The bread and butter of the Data Farming incentive program is [Volume DF](../../rewards/df-volumedf.md). Here publishers and curators that help maintain quality assets in the Ocean ecosystem are rewarded. +The bread and butter of the Data Farming incentive program is [Volume DF](../df-volumedf.md). Here publishers and curators that help maintain quality assets in the Ocean ecosystem are rewarded. You can receive OCEAN rewards by allocating veOCEAN voting power to high-quality datasets and assisting Ocean with the curation of Data assets. Through this allocation, you will also receive a portion of the revenue generated by the dataset consumption. @@ -42,7 +42,7 @@ For more information on how to get started and detailed instructions, please ref ### Challenge DF Substream -If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. [Challenge DF](../../rewards/df-challengedf.md) provides a competition where you can test your skills in predicting the price of Ethereum. Earn a place on the podium to receive a reward. +If you are a data scientist and enjoy tackling challenging problems, this is the perfect place for you. [Challenge DF](../df-challengedf.md) provides a competition where you can test your skills in predicting the price of Ethereum. Earn a place on the podium to receive a reward. This opportunity allows you to explore the capabilities offered by Ocean Protocol to build algorithms, publish data assets, and to gain valuable exposure. As your models and skills improve, you can begin monetizing your work. diff --git a/user-guides/data-farming/how-to-challengedf.md b/rewards/user-guides/how-to-challengedf.md similarity index 96% rename from user-guides/data-farming/how-to-challengedf.md rename to rewards/user-guides/how-to-challengedf.md index bdaa030d..33280907 100644 --- a/user-guides/data-farming/how-to-challengedf.md +++ b/rewards/user-guides/how-to-challengedf.md @@ -8,7 +8,7 @@ description: Make extra dosh with building prediction models ## Predict to earn -If you're eager to begin extracting value from data but aren't sure how to get started, then [Challenge DF is here to help](../../rewards/df-challengedf.md)! +If you're eager to begin extracting value from data but aren't sure how to get started, then [Challenge DF is here to help](../df-challengedf.md)! By participating in the weekly data challenges of predicting the price of Ethereum, you will become familiar with the Ocean Protocol stack and with building predictions that can be sold for money. diff --git a/user-guides/data-farming/how-to-claim-rewards.md b/rewards/user-guides/how-to-claim-rewards.md similarity index 100% rename from user-guides/data-farming/how-to-claim-rewards.md rename to rewards/user-guides/how-to-claim-rewards.md diff --git a/user-guides/data-farming/how-to-delegate.md b/rewards/user-guides/how-to-delegate.md similarity index 100% rename from user-guides/data-farming/how-to-delegate.md rename to rewards/user-guides/how-to-delegate.md diff --git a/user-guides/data-farming/how-to-estimate-apy.md b/rewards/user-guides/how-to-estimate-apy.md similarity index 87% rename from user-guides/data-farming/how-to-estimate-apy.md rename to rewards/user-guides/how-to-estimate-apy.md index dc4ef1bd..0f7053b0 100644 --- a/user-guides/data-farming/how-to-estimate-apy.md +++ b/rewards/user-guides/how-to-estimate-apy.md @@ -12,7 +12,7 @@ Rewards are earned by users that hold and use their veOCEAN to help the protocol To receive competitve short-term APYs, veOCEAN requires users to make long-term commitments. -First, make sure that you [understand the basics of APY](../../rewards/df-veocean.md#veocean-and-your-apy) and how veOCEAN works. +First, make sure that you [understand the basics of APY](../df-veocean.md#veocean-and-your-apy) and how veOCEAN works. Now that we got that out of the way, let's work through the examples and keep it as simple as possible. @@ -36,6 +36,6 @@ To help solve this challenge, [we built a dashboard](https://df.oceandao.org/vol

Curate like a Pro.

-You can also [learn how rewards are calculated](../../rewards/df-volumedf.md#how-rewards-are-calculated) to understand more about what's happening behind the scenes of each Data Farming round. +You can also [learn how rewards are calculated](../df-volumedf.md#how-rewards-are-calculated) to understand more about what's happening behind the scenes of each Data Farming round. Finally, you can [review the implementation inside df-web](https://github.com/oceanprotocol/df-web/blob/main/src/utils/rewards.js) to understand how the APYs on the UI are calculated. \ No newline at end of file diff --git a/user-guides/data-farming/how-to-veocean.md b/rewards/user-guides/how-to-veocean.md similarity index 100% rename from user-guides/data-farming/how-to-veocean.md rename to rewards/user-guides/how-to-veocean.md diff --git a/user-guides/data-farming/how-to-volumedf.md b/rewards/user-guides/how-to-volumedf.md similarity index 100% rename from user-guides/data-farming/how-to-volumedf.md rename to rewards/user-guides/how-to-volumedf.md