Skip to content

Commit

Permalink
Fix website
Browse files Browse the repository at this point in the history
  • Loading branch information
@Noc2
Noc2 committed Sep 20, 2023
1 parent 2753ba5 commit eff195b
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions applications/StorageHub.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | Copyright and Licenses | CC BY 4.0 / GPLv3 |
| **0b.** | Research & Investigation | * Understand and clarify key requirements via conversations with key stakeholders <br> * Study existing solutions and designs to see what technologies and approaches can be leveraged vs. being created <br> * Research decentralized storage competitive projects, including but not limited to Filecoin, Arweave, Sia, Storj as well as existing storage work in the Polkadot ecosystem <br> * Examine trade offs other decentralized storage providers have made including, but not limited to retrieval times, small v. large files, resiliency, cost efficacy, security & privacy, redundancy, user learning curve and environmental sustainability <br> * Begin to design features compatible with Polkadot’s technical approach and philosophy <br> * The research & design document will include the gathered requirements and the list of researched solutions & features that could meet those requirements, as well as all supporting evidence and documentation that led to those proposed requirements and features. The document will also expand its research on the “Key Questions and Anticipated Challenges” section |
| **0c.** | Feature Analysis | * In depth research of the technical feasibility of key features and components <br> *Evaluation of proposed feature sets, inclusive of a detailed compatibility/tradeoff matrix leading to a clearly defined set of proposed StorageHub features <br> * Stakeholders will be asked to provide feedback on those compatibility/tradeoffs and to help choose a good combination of features <br> * Definition and documentation of key use cases and scenarios |
| **0b.** | Research & Investigation | * Understand and clarify key requirements via conversations with key stakeholders <br/> * Study existing solutions and designs to see what technologies and approaches can be leveraged vs. being created <br/> * Research decentralized storage competitive projects, including but not limited to Filecoin, Arweave, Sia, Storj as well as existing storage work in the Polkadot ecosystem <br/> * Examine trade offs other decentralized storage providers have made including, but not limited to retrieval times, small v. large files, resiliency, cost efficacy, security & privacy, redundancy, user learning curve and environmental sustainability <br/> * Begin to design features compatible with Polkadot’s technical approach and philosophy <br/> * The research & design document will include the gathered requirements and the list of researched solutions & features that could meet those requirements, as well as all supporting evidence and documentation that led to those proposed requirements and features. The document will also expand its research on the “Key Questions and Anticipated Challenges” section |
| **0c.** | Feature Analysis | * In depth research of the technical feasibility of key features and components <br/> *Evaluation of proposed feature sets, inclusive of a detailed compatibility/tradeoff matrix leading to a clearly defined set of proposed StorageHub features <br/> * Stakeholders will be asked to provide feedback on those compatibility/tradeoffs and to help choose a good combination of features <br/> * Definition and documentation of key use cases and scenarios |
| **0d.** | Article | * The main deliverable for the first month is v0.5 of the research & design document. The research and design document will include the feature analysis, proposed MVP feature set including key use cases, and address the points in (0b.) and (0c.) |

### Milestone #2: Technical Deliverables
Expand All @@ -156,12 +156,12 @@
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| **0a.** | License Type | CC BY 4.0 / GPLv3 |
| **0b.** | Documentation | * For the second milestone we will provide v1.0 of the research & design document. The v1.0 document will include a high level technical design & architecture of StorageHub, including major subsystems, incorporating and building upon research from the first v0.5 milestone <br> * This v1.0 research and design document will be shared with key stakeholders to obtain specific feedback that will help us continue to refine StorageHub <br> * In addition to this, we will also begin to build prototype code that supports and tests the v1.0 technical design considerations. A basic tutorial will be included that explains how a user can run our prototype code and send test transactions |
| **0c.** | Testing & Testing Guide | * Software developed for this milestone will be prototype quality, and thus will not have the tests required for production deployment. However, the prototype code will be sufficient to demonstrate viability or compatibility of key aspects of the design approach <br> * As outlined in (0b.), a basic tutorial will be included that explains how a user can run our prototype code and send test transactions |
| **0b.** | Documentation | * For the second milestone we will provide v1.0 of the research & design document. The v1.0 document will include a high level technical design & architecture of StorageHub, including major subsystems, incorporating and building upon research from the first v0.5 milestone <br/> * This v1.0 research and design document will be shared with key stakeholders to obtain specific feedback that will help us continue to refine StorageHub <br/> * In addition to this, we will also begin to build prototype code that supports and tests the v1.0 technical design considerations. A basic tutorial will be included that explains how a user can run our prototype code and send test transactions |
| **0c.** | Testing & Testing Guide | * Software developed for this milestone will be prototype quality, and thus will not have the tests required for production deployment. However, the prototype code will be sufficient to demonstrate viability or compatibility of key aspects of the design approach <br/> * As outlined in (0b.), a basic tutorial will be included that explains how a user can run our prototype code and send test transactions |
| **0d.** | Docker | * We will provide a Dockerfile(s) that can be used to run the prototype associated with this milestone |
| **0e.** | Prototype Code | * We will create a Substrate and or RUST prototype to validate proposed designs described in the v1.0 design doc. In particular, the approach for the data provider role, and being able to store data in a redundant fashion, and retrieve data from the provider <br> * The source code for the prototype will be delivered as part of the second month milestone. The prototype will have limited features (e.g. not decentralized, limited API, etc) or might not be complete but will provide sufficient functionalities to demonstrate key parts of the proposed design <br> * We will provide a Dockerfile(s) that can be used to run the prototype associated with this milestone |
| **0f.** | Resource Estimation & Planning | * Estimate the time, budget, and resources required to implement a minimum viable feature set for the project <br> * Break down the feature into smaller tasks or user stories <br> * Create a proposed project plan that includes implementation milestones, and responsibilities <br> * Include proposed next steps in the research and design doc |
| **0g.** | Article | * The main deliverables for this milestone are defined as below <br> * Progressing the v0.5 document to a v1.0 state outlined in section (0b.) <br> * A Substrate and or RUST prototype to validate proposed designs described in the v1.0, outlined in section (0e.) <br> * A basic tutorial will be included that explains how a user can run our prototype code and send test transactions outlined in section (0c.) |
| **0e.** | Prototype Code | * We will create a Substrate and or RUST prototype to validate proposed designs described in the v1.0 design doc. In particular, the approach for the data provider role, and being able to store data in a redundant fashion, and retrieve data from the provider <br/> * The source code for the prototype will be delivered as part of the second month milestone. The prototype will have limited features (e.g. not decentralized, limited API, etc) or might not be complete but will provide sufficient functionalities to demonstrate key parts of the proposed design <br/> * We will provide a Dockerfile(s) that can be used to run the prototype associated with this milestone |
| **0f.** | Resource Estimation & Planning | * Estimate the time, budget, and resources required to implement a minimum viable feature set for the project <br/> * Break down the feature into smaller tasks or user stories <br/> * Create a proposed project plan that includes implementation milestones, and responsibilities <br/> * Include proposed next steps in the research and design doc |
| **0g.** | Article | * The main deliverables for this milestone are defined as below <br/> * Progressing the v0.5 document to a v1.0 state outlined in section (0b.) <br/> * A Substrate and or RUST prototype to validate proposed designs described in the v1.0, outlined in section (0e.) <br/> * A basic tutorial will be included that explains how a user can run our prototype code and send test transactions outlined in section (0c.) |


## Future Plans
Expand Down

0 comments on commit eff195b

Please sign in to comment.