From a87b10c612144311249580da8f9e6ecb92fa805a Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Fri, 26 Jul 2019 14:11:58 +0200 Subject: [PATCH] new note style --- content/concepts/ocean-tokens.md | 29 ++++++++++--------- content/concepts/resources.md | 2 ++ content/concepts/terminology.md | 4 +-- content/concepts/vulnerabilities.md | 2 +- content/setup/marketplace.md | 6 ++-- content/tutorials/amazon-s3-for-brizo.md | 6 ++-- .../tutorials/get-ether-and-ocean-tokens.md | 2 +- content/tutorials/metamask-setup.md | 2 +- content/tutorials/on-premise-for-brizo.md | 2 +- content/tutorials/react-get-use-data-set.md | 10 +++---- src/components/DocContent.module.scss | 19 ++++++++++++ src/styles/_code.scss | 15 ++-------- 12 files changed, 57 insertions(+), 42 deletions(-) diff --git a/content/concepts/ocean-tokens.md b/content/concepts/ocean-tokens.md index e47f475c..adf23c35 100644 --- a/content/concepts/ocean-tokens.md +++ b/content/concepts/ocean-tokens.md @@ -38,27 +38,25 @@ At the time of writing, you could use Ethereum Mainnet Ocean Tokens to do variou There are many ways to check your Ethereum Mainnet Ocean Token balance. Starting with the easiest, here are some ways: ---- +#### Ocean Token Tool -- Enter your account address into the form in the [Ocean Token Tool](https://wallet.oceanprotocol.com/tokens). +Enter your account address into the form in the [Ocean Token Tool](https://wallet.oceanprotocol.com/tokens). [![Ocean Token Tool](images/token-tool.png)](https://wallet.oceanprotocol.com/tokens) ---- +#### Blowfish -- Go to [Etherscan](https://etherscan.io/), enter your account address into the search field, click **Search**, click on **Erc20 Token Txns**, look for an _OceanToken_ transaction in the _Token_ colum, and click on **OceanToken** there. - ---- - -- Download and use [Blowfish](https://github.com/kremalicious/blowfish), a desktop app that tells you your Ocean Token balance (and other things). +Download and use [Blowfish](https://github.com/kremalicious/blowfish), a desktop app that tells you your Ocean Token balance (and other things). [![Blowfish](images/blowfish.png)](https://github.com/kremalicious/blowfish) ---- +#### MetaMask -- Use MetaMask or other ERC-20-compatible wallet software. See the page about [using wallet software to manage Ocean Tokens](/tutorials/wallets-and-ocean-tokens/). You can also use wallet software to send Ocean Tokens to some other account. +Use MetaMask or other ERC-20-compatible wallet software. See the page about [using wallet software to manage Ocean Tokens](/tutorials/wallets-and-ocean-tokens/). You can also use wallet software to send Ocean Tokens to some other account. ---- +#### Etherscan + +Go to [Etherscan](https://etherscan.io/), enter your account address into the search field, click **Search**, click on **Erc20 Token Txns**, look for an _OceanToken_ transaction in the _Token_ colum, and click on **OceanToken** there. ### Buy or Sell Ethereum Mainnet Ocean Tokens @@ -78,6 +76,8 @@ Below is the _official list_ of exchanges which listed Ethereum Mainnet Ocean To Ocean Tokens in Ocean's Mainnet, [Pacific](/concepts/pacific-network/), represent the same value as in the Ethereum Mainnet. The only way to get Ocean Tokens in Pacific is to transfer them from the Ethereum Mainnet. +### Ocean Token Bridge + For this purpose there is a token bridge between the Ethereum Mainnet and the Pacific Network, allowing anyone with Ocean Tokens to move them from the Ethereum Mainnet to the Pacific Network, and vice versa. - [**Ocean Token Bridge**](https://bridge.oceanprotocol.com) @@ -114,6 +114,9 @@ The [Example Code page](/tutorials/example-code/) has links to example Squid cod ## Further Reading about Ocean Tokens - [Tutorial: Use Your Wallet to Manage Ocean Tokens](/tutorials/wallets-and-ocean-tokens/) -- [Ocean Tokenomics](https://blog.oceanprotocol.com/ocean-tokenomics-d34f28c480a8) -- [Ocean Tokenomics II](https://blog.oceanprotocol.com/https-blog-oceanprotocol-com-ocean-tokenomics-ii-faf05854314b) +- [Blog: Ocean Tokenomics](https://blog.oceanprotocol.com/ocean-tokenomics-d34f28c480a8) +- [Blog: Ocean Tokenomics II](https://blog.oceanprotocol.com/https-blog-oceanprotocol-com-ocean-tokenomics-ii-faf05854314b) - [Ocean Protocol Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf) +- [Blog: What Happened with the IEO?](https://blog.oceanprotocol.com/what-happened-with-the-ieo-54cc5c6c3db9) +- [Blog: Ocean Protocol — Token Sale](https://blog.oceanprotocol.com/ocean-protocol-token-sale-96d03f968e22) +- [Blog: Ocean Protocol Pre-Launch is Target Reached](https://blog.oceanprotocol.com/ocean-protocol-pre-launch-is-target-reached-d10e53272a2e) diff --git a/content/concepts/resources.md b/content/concepts/resources.md index 9f27d908..4104b117 100644 --- a/content/concepts/resources.md +++ b/content/concepts/resources.md @@ -64,6 +64,8 @@ Already familiar with Ocean and want to jump into the tech? These blog posts exp - [Project Manta Ray — Data Science powered by Ocean Protocol](https://blog.oceanprotocol.com/project-manta-ray-data-science-powered-by-ocean-protocol-535c54089b0f) - [Ocean ♥ Docker](https://blog.oceanprotocol.com/ocean-docker-d43d992d8ecf) - [How to Swim in the Ocean: Introducing Squid Libraries](https://blog.oceanprotocol.com/ocean-protocol-squid-library-java-c92a6035ce39) +- [The Commons Marketplace](https://blog.oceanprotocol.com/the-commons-data-marketplace-c57a44288314) +- [The Commons Marketplace in Pacific Network](https://blog.oceanprotocol.com/the-commons-marketplace-in-pacific-network-4bcf2f595721) ## Videos diff --git a/content/concepts/terminology.md b/content/concepts/terminology.md index 8423b83f..d46a57b7 100644 --- a/content/concepts/terminology.md +++ b/content/concepts/terminology.md @@ -19,13 +19,13 @@ Anything that can be registered with and made available via an Ocean Network. Ex 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. -Note: Initially, most data owners or data service providers will also be the publishers of their own assets. +> Initially, most data owners or data service providers will also be the publishers of their own assets. ## Publisher A service which mediates access to assets on behalf of data owners or data service providers. -Note: Initially, most publishers will also be the owners of the assets they publish. +> Initially, most publishers will also be the owners of the assets they publish. ## Consumer diff --git a/content/concepts/vulnerabilities.md b/content/concepts/vulnerabilities.md index 5a158ed9..98c43e4a 100644 --- a/content/concepts/vulnerabilities.md +++ b/content/concepts/vulnerabilities.md @@ -3,4 +3,4 @@ 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 security@oceanprotocol.com. +> You can responsibly disclose flaws by emailing us at security@oceanprotocol.com. diff --git a/content/setup/marketplace.md b/content/setup/marketplace.md index bd6e0074..96802514 100644 --- a/content/setup/marketplace.md +++ b/content/setup/marketplace.md @@ -20,7 +20,7 @@ At the time of writing, the following kinds of [assets](/concepts/terminology/#a - data sets stored in Amazon S3 storage (i.e. with "s3://" in their URL). See [the tutorial about setting up Amazon S3 storage to work with Ocean Protocol](/tutorials/amazon-s3-for-brizo/). - data sets stored in on-premise storage. See [the tutorial about setting up on-premise storage to work with Ocean Protocol](/tutorials/on-premise-for-brizo/). -Note: You can use _all_ of the above. You aren't restricted to using only one storage provider. +> You can use _all_ of the above. You aren't restricted to using only one storage provider. Support for other kinds of assets (e.g. computing in Azure) is coming. @@ -29,7 +29,7 @@ Support for other kinds of assets (e.g. computing in Azure) is coming. At the time of writing, we recommend the following steps to develop a marketplace/publisher app: 1. Do the [React App Tutorial](/tutorials/react-setup/). -1. Grow your app from there. +2. Grow your app from there. For more examples and inspiration, check out [the source code for Pleuston](https://github.com/oceanprotocol/pleuston) and the [the source code for the Commons Marketplace](https://github.com/oceanprotocol/commons). Both have an Apache v2 open source license. Both use React and squid-js. Both are "serverless" apps: they run entirely in the browser and have no server-side component. @@ -44,7 +44,7 @@ A marketplace/publisher app could have both a back-end component and a front-end -Note: There are examples of how to use squid-py in the [Tutorials](/tutorials/introduction/). squid-py is to Ocean like boto3 is to AWS. +> There are examples of how to use squid-py in the [Tutorials](/tutorials/introduction/). squid-py is to Ocean like boto3 is to AWS. Of course, you could always write your own Squid library in the language of your choice. diff --git a/content/tutorials/amazon-s3-for-brizo.md b/content/tutorials/amazon-s3-for-brizo.md index 3cb3b322..62b4574a 100644 --- a/content/tutorials/amazon-s3-for-brizo.md +++ b/content/tutorials/amazon-s3-for-brizo.md @@ -3,10 +3,12 @@ title: Set Up Amazon S3 Storage description: Tutorial about how to set up Amazon S3 storage for use with Ocean Protocol. --- -To enable Brizo to use files stored in Amazon S3 (i.e. files with an URL containing "s3://"), you must: +To enable Brizo to use files stored in Amazon S3 (i.e. files with an URL containing `s3://`), you must: 1. have an Amazon AWS user account (IAM account) with permission to read those files from S3, and 1. set the AWS credentials on the machine where Brizo is running to those of the AWS user in question. Instructions are given below. 1. Note that you don't have to set any Brizo-specific configuration settings, e.g. in the `[osmosis]` section of the Brizo config file or in some special Brizo environment variables. -Under the hood, Brizo uses [boto3](https://aws.amazon.com/sdk-for-python/) (the Python library for interacting with AWS) to interact with AWS and boto3 has a whole process for determining AWS credentials. The easiest way to set the AWS credentials on the machine where Brizo is running is to install the [AWS CLI](https://aws.amazon.com/cli/) and then use the `aws configure` command. For more details, see [the boto3 user guide about credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html). +Under the hood, Brizo uses [boto3](https://aws.amazon.com/sdk-for-python/) (the Python library for interacting with AWS) to interact with AWS and boto3 has a whole process for determining AWS credentials. The easiest way to set the AWS credentials on the machine where Brizo is running is to install the [AWS CLI](https://aws.amazon.com/cli/) and then use the `aws configure` command. + +For more details, see [the boto3 user guide about credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html). diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 118b1725..a3b790c3 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -79,7 +79,7 @@ That command uses [Ethereum's JSON RPC API](https://wiki.parity.io/JSONRPC.html) Details about the bootstrapped accounts can be found in [the README.md file in the Barge repository](https://github.com/oceanprotocol/barge/#spree-network). They're the ones of type "mnemonic." -**WARNING!** Never use any of those accounts in any mainnet. They are for testing purposes only. +> **WARNING!** Never use any of those accounts in any mainnet. They are for testing purposes only. **Option 3:** Another option is to run [the Ocean faucet server](https://github.com/oceanprotocol/faucet) on your machine, with default configuration settings. The default settings enable it to dispense Spree Ether. To ask the faucet to send some Spree Ether to ``, use the command (a long command that wraps around): diff --git a/content/tutorials/metamask-setup.md b/content/tutorials/metamask-setup.md index 2d2f6255..e0cba5c9 100644 --- a/content/tutorials/metamask-setup.md +++ b/content/tutorials/metamask-setup.md @@ -3,7 +3,7 @@ title: Set Up MetaMask description: Tutorial about how to set up MetaMask for Chrome. --- -**Note: MetaMask can also be used with a TREZOR or Ledger hardware wallet but we don't cover those options below; see [the MetaMask documentation](https://metamask.zendesk.com/hc/en-us/articles/360020394612-How-to-connect-a-Trezor-or-Ledger-Hardware-Wallet).** +> MetaMask can also be used with a TREZOR or Ledger hardware wallet but we don't cover those options below; see [the MetaMask documentation](https://metamask.zendesk.com/hc/en-us/articles/360020394612-How-to-connect-a-Trezor-or-Ledger-Hardware-Wallet). 1. Go to the [Chrome Web Store for extensions](https://chrome.google.com/webstore/category/extensions) and search for MetaMask. diff --git a/content/tutorials/on-premise-for-brizo.md b/content/tutorials/on-premise-for-brizo.md index 1c06abb2..f2d141a9 100644 --- a/content/tutorials/on-premise-for-brizo.md +++ b/content/tutorials/on-premise-for-brizo.md @@ -3,6 +3,6 @@ title: Set Up On-Premise Storage description: Tutorial about how to set up on-premise storage for use with Ocean Protocol. --- -To enable Brizo to use files stored in on-premise storage (i.e. files with an URL not containing "core.windows.net" or "s3://"), there is _nothing to do, other than make sure Brizo can resolve the URLs_. In particular, you don't have to set any Brizo-specific configuration settings, e.g. in the `[osmosis]` section of the Brizo config file or in some special Brizo environment variables. +To enable Brizo to use files stored in on-premise storage (i.e. files with an URL not containing `core.windows.net` or `s3://`), there is _nothing to do, other than make sure Brizo can resolve the URLs_. In particular, you don't have to set any Brizo-specific configuration settings, e.g. in the `[osmosis]` section of the Brizo config file or in some special Brizo environment variables. Local and private network URLs are fine so long as they can be resolved by Brizo. Potential examples include `http://localhost/helicopter_data.xls`, `http://192.168.12.34/almond_sales_2012.csv` and `http://10.12.34.56/duck_photos.zip`. diff --git a/content/tutorials/react-get-use-data-set.md b/content/tutorials/react-get-use-data-set.md index b37dc1c0..83325019 100644 --- a/content/tutorials/react-get-use-data-set.md +++ b/content/tutorials/react-get-use-data-set.md @@ -28,7 +28,7 @@ async retrieveAssets() { // ... ``` -Now we need a button to start our search inside the render function just after ``: +Now we need a button to start our search inside the render function just after the _Register asset_ button: ```jsx:title=src/App.js // ... @@ -70,7 +70,7 @@ async consumeAsset() { // ... ``` -We still need a button to start consumption. In the render function, just after the `` line, add: +We still need a button to start consumption. In the render function, just after the _Retrieve assets_ button, add: ```jsx:title=src/App.js // ... @@ -82,13 +82,13 @@ With all these buttons in place, you should see this: ![React App 05](images/react-app-05.png) -Tip: Before clicking the `Retrieve assets` button, it might help to reload the page. +> Tip: Before clicking the `Retrieve assets` button, it might help to reload the page. -Go ahead and click the `Retrieve assets` button, and then the `Consume asset` button. Approve all the MetaMask dialog boxes. +Go ahead and click the _Retrieve assets_ button, and then the _Consume asset_ button. Approve all the MetaMask dialog boxes. Have a look into `console.log` to see the various steps of the search and consume process. If you have no errors in your `console.log` and can see your asset files listed, you have a working marketplace. -> Note: Consuming an asset will throw an error `Requested did is not found in the keeper network`. We are currently [investigating why that is happening](https://github.com/oceanprotocol/barge/issues/144) in either squid-js or Brizo and will remove this note once we verified a fix is in place in one of those components. +> Consuming an asset will throw an error `Requested did is not found in the keeper network`. We are currently [investigating why that is happening](https://github.com/oceanprotocol/barge/issues/144) in either squid-js or Brizo and will remove this note once we verified a fix is in place in one of those components. ## Final Result diff --git a/src/components/DocContent.module.scss b/src/components/DocContent.module.scss index 3f896aa2..da655a0a 100644 --- a/src/components/DocContent.module.scss +++ b/src/components/DocContent.module.scss @@ -27,6 +27,25 @@ word-wrap: normal; word-break: normal; } + + // use blockquote for info blocks + blockquote { + padding: $spacer / 2; + background: lighten($brand-grey-light, 36%); + border-left: .25rem solid $brand-grey-light; + border-top-right-radius: $border-radius; + border-bottom-right-radius: $border-radius; + + &, + p { + color: $brand-blue; + font-style: italic; + } + + p:last-child { + margin-bottom: 0; + } + } } .empty { diff --git a/src/styles/_code.scss b/src/styles/_code.scss index 7ff156c5..8f69b48a 100644 --- a/src/styles/_code.scss +++ b/src/styles/_code.scss @@ -34,8 +34,7 @@ a > code { pre { display: block; - margin: 0; - margin-bottom: $spacer; + margin: $spacer / 2 0; padding: 0; position: relative; background: lighten($brand-grey-light, 35%) !important; @@ -128,6 +127,7 @@ pre[data-language='markdown']:before { .gatsby-code-title { background: lighten($brand-grey-light, 35%); padding: $spacer / 4 $spacer / 2; + margin-bottom: -($spacer / 2); border-bottom: 1px solid $brand-white; font-family: $font-family-monospace; color: $brand-grey-light; @@ -149,14 +149,3 @@ pre[data-language='markdown']:before { width: calc(100% + #{$spacer * 1.5}); } } - -.vscode-highlight { - --vscode-highlight-line-highlighted-border-color: rgba( - 255, - 255, - 255, - .5 - ); /* default: transparent */ - - --vscode-highlight-line-highlighted-border-width: 2px; /* default: 2px */ -}