docs icon indicating copy to clipboard operation
docs copied to clipboard

Add optional userdata to url storage type, add arweave storage type.

Open MantisClone opened this issue 3 years ago • 11 comments

Fixes #1131

This is a continuation of PR #1019.

Changes proposed in this PR:

  • Add arweave storage type
  • Re-format the storage object section to use regular code blocks instead of code blocks embedded in tables.

Screenshot of the changes

TODO

MantisClone avatar Jul 28 '22 18:07 MantisClone

Deploy Preview for docs-oceanprotocol processing.

Name Link
Latest commit 5429780fc614ebae47e86a9e70c48ec8a7ac321b
Latest deploy log https://app.netlify.com/sites/docs-oceanprotocol/deploys/62e2d2576ce7c30009919ca3

netlify[bot] avatar Jul 28 '22 18:07 netlify[bot]

@jamiehewitt15 I believe this PR is ready for review.

MantisClone avatar Jul 28 '22 18:07 MantisClone

Thanks @MantisClone, is this dependant on https://github.com/oceanprotocol/provider/pull/485?

Given that Arweave is completely new, it would be great to have a bit more explanation somewhere about it's benefits and how it can be used. Many people will still be unfamiliar with it.

jamiehewitt15 avatar Jul 29 '22 07:07 jamiehewitt15

Thanks @MantisClone, is this dependant on oceanprotocol/provider#485?

@jamiehewitt15 Yes.

The complete list of related PRs includes:

  • https://github.com/oceanprotocol/provider/pull/485
  • https://github.com/oceanprotocol/ocean.py/pull/860
  • https://github.com/oceanprotocol/barge/pull/295
  • https://github.com/oceanprotocol/aquarius/pull/832
  • https://github.com/oceanprotocol/market/pull/1527
  • ocean.js PR not yet created

Given that Arweave is completely new, it would be great to have a bit more explanation somewhere about it's benefits and how it can be used. Many people will still be unfamiliar with it.

That's a fair critique. Here are the pages I think will need edits:

  • "Publishing with hosting services" could use a new Arweave section - explaining benefits and how to upload
  • "Publish a data asset" needs to show and explain the new "Storage type" field on the publish page.

Do you agree? Is there any other documentation you believe is required?

MantisClone avatar Jul 29 '22 14:07 MantisClone

I would remove both headers & userdata for arweave type, since they are not applicable

alexcos20 avatar Aug 08 '22 13:08 alexcos20

@MantisClone this is still marked as draft. Are you still actively working on it?

jamiehewitt15 avatar Sep 26 '22 10:09 jamiehewitt15

Yeah I was planning to finish it off this week. Last week I was just trying to get my Ocean.py pr merged.

MantisClone avatar Sep 26 '22 11:09 MantisClone

Yeah I was planning to finish it off this week. Last week I was just trying to get my Ocean.py pr merged.

Ok cool, fair enough

jamiehewitt15 avatar Sep 26 '22 12:09 jamiehewitt15

@jamiehewitt15 I added Arweave upload instructions to core-concepts/asset-hosting.md, per your request. https://github.com/oceanprotocol/docs/pull/1082/files#diff-e17aa10544eed5b37e241d4e4e30523e0040f2ca72f22afacaf7002a091ed3b3R20-R57

The instructions are missing a screenshot of the Storage type and Transaction ID fields on the Ocean Market publish page. These fields are implemented in https://github.com/oceanprotocol/market/pull/1527 but it hasn't been merged yet.

Unfortunately, my latest commits seem to have added a bunch of unnecessary edits like image files that aren't actually used and needlessly changing image URLs to be absolute images/ instead of relative ../. :weary: Also, it looks like I'm out of date with main again. So I'll work on syncing and cleaning stuff up.

MantisClone avatar Sep 27 '22 13:09 MantisClone

This PR used to include changes to the DDO spec to add the Arweave file type. These changes were superseded by https://github.com/oceanprotocol/docs/pull/1137

The remaining changes explain how to upload files to Arweave.

As such, the title of this PR no longer makes sense so I'm renaming it to better reflect its content.

MantisClone avatar Oct 10 '22 22:10 MantisClone

Code Climate has analyzed commit 7486b5cf and detected 0 issues on this pull request.

View more on Code Climate.

qlty-cloud-legacy[bot] avatar Oct 10 '22 22:10 qlty-cloud-legacy[bot]

@MantisClone As we recently added Arweave support to the market, we can finish these changes. I understand that it has been a while since you started working on this and perhaps your priorities have changed. Is it ok for you if we take it over?

LoznianuAnamaria avatar Dec 19 '22 14:12 LoznianuAnamaria

Hi @AnaLoznianu. 👋 Yes, you can take over.

MantisClone avatar Dec 19 '22 15:12 MantisClone

Thanks, I moved this to a new PR: https://github.com/oceanprotocol/docs/pull/1165 as yours is coming from a fork with makes it a bit difficult. Thank you 🙏

LoznianuAnamaria avatar Dec 20 '22 13:12 LoznianuAnamaria