From 7a47ddccc51eb5ac65e51fc4962dba2684a4a69e Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 7 Nov 2018 15:51:17 +0100 Subject: [PATCH] Some initial docs --- content/core-concepts/terminology.md | 46 ++++++++++++++++++++++++++++ content/coreconcepts/components.md | 3 -- content/setup/keeper.md | 3 ++ content/setup/marketplace.md | 2 +- content/setup/publisher.md | 3 ++ content/tutorials/jupyter.md | 4 +-- 6 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 content/core-concepts/terminology.md delete mode 100644 content/coreconcepts/components.md create mode 100644 content/setup/keeper.md create mode 100644 content/setup/publisher.md diff --git a/content/core-concepts/terminology.md b/content/core-concepts/terminology.md new file mode 100644 index 00000000..b0382e7a --- /dev/null +++ b/content/core-concepts/terminology.md @@ -0,0 +1,46 @@ +--- +title: Terminology +--- + +There is terminology specific to Ocean Protocol. + +## Asset + +A data set or data service. + +## Publisher + +Someone who has assets that they want to sell (or give away freely). An example is an almond distributor with 30 years of data about almond sales. + +## Consumer + +Someone who wants assets. An example is a data scientist working at an economic think tank. + +## Marketplace + +A service where publishers can list what assets they have, and consumers can see what's available then buy it (or get it for free). + +## Keeper + +A computer running a blockchain client (i.e. a blockchain node) where the associated blockchain network is running the Ocean Protocol keeper contracts (smart contracts). + +## Aquarius + +Ocean-specific software to help store and manage metadata about assets (but not assets themselves). Every marketplace must run an instance of Aquarius. + +## Brizo + +Ocean-specific software to help publishers manage consumer access to their assets. + +## Secret Store + +[Parity Secret Store](https://wiki.parity.io/Secret-Store). + +## Squid + +A set of software libraries to interact with Ocean network participants, including Keepers, Aquarius, Brizo, and Secret Store. The initial libraries are in Python, JavaScript and Java. + +## Pleuston + +An example marketplace frontend implemented using React and Squid-JavaScript. + diff --git a/content/coreconcepts/components.md b/content/coreconcepts/components.md deleted file mode 100644 index 70bd2bdd..00000000 --- a/content/coreconcepts/components.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: The components of Ocean Protocol ---- diff --git a/content/setup/keeper.md b/content/setup/keeper.md new file mode 100644 index 00000000..9189672c --- /dev/null +++ b/content/setup/keeper.md @@ -0,0 +1,3 @@ +--- +title: Set Up a Keeper +--- diff --git a/content/setup/marketplace.md b/content/setup/marketplace.md index 6b56f819..a3b8c161 100644 --- a/content/setup/marketplace.md +++ b/content/setup/marketplace.md @@ -1,3 +1,3 @@ --- -title: Set up a data marketplace +title: Set Up a Marketplace --- diff --git a/content/setup/publisher.md b/content/setup/publisher.md new file mode 100644 index 00000000..a89126b2 --- /dev/null +++ b/content/setup/publisher.md @@ -0,0 +1,3 @@ +--- +title: Publish Data or Services +--- diff --git a/content/tutorials/jupyter.md b/content/tutorials/jupyter.md index 2dd04817..d8d433f5 100644 --- a/content/tutorials/jupyter.md +++ b/content/tutorials/jupyter.md @@ -1,5 +1,5 @@ --- -title: Use Jupyter notebooks to interact with the Ocean network +title: Example Jupyter Notebooks to Interact with the Ocean Network --- -How to use Mantaray? +(Mantaray)