awesome-ipfs icon indicating copy to clipboard operation
awesome-ipfs copied to clipboard

Discussion: App submission form fields

Open Ricardo-Silva91 opened this issue 5 years ago • 8 comments
trafficstars

Hello! Has I said in the other issue (#366), this is for discussing what we think are the relevant fields for the app submission form. Currently the fields that translate to what the cards show seem to be:

  • App Name (required)
  • Description
  • link to code (github) (at least one of the links should exist)
  • link to website (at least one of the links should exist)
  • picture

But maybe some more info could be saved. What do you think? 🙂

Ricardo-Silva91 avatar Nov 13 '20 16:11 Ricardo-Silva91

What about a multi-select for industry/subject area? I'm hoping to include one in a future interactive version of our ecosystem diagram, so if both of these resources could use the same list, that would be awesome - and would enable IPFS newcomers to search/filter more effectively for things relevant to them.

Rough first draft of list below, but a start. I'm sure @autonome would like to weigh in, too ... this list is a bit long and could likely be reorganized or consolidated:

  • E-commerce & marketplaces
  • CDNs & content providers (including hosting)
  • Streaming
  • Non-fungible tokens
  • Decentralized finance
  • Prediction & gaming
  • Social media
  • Data markets
  • Data persistence & archiving (including pinning)
  • Academic, public, and community data
  • Data governance
  • Self-sovereign identity
  • Dev tools
  • Mobile
  • IoT
  • Machine learning & big data
  • Community and mesh networks
  • VR/AR

jessicaschilling avatar Nov 13 '20 16:11 jessicaschilling

Maybe something about the maturity level would be helpful? Whether it's meant for production use or not?

atopal avatar Nov 17 '20 20:11 atopal

@atopal What about a "select level of product maturity" spectrum? Below represents intent I'm thinking of (but definitely not official wording): 1 - experimental, use at your own risk 2 - alpha 3 - beta 4 - production-ready 5 - production-ready with some proven scale

jessicaschilling avatar Nov 17 '20 20:11 jessicaschilling

That looks good to me, or maybe simplified: experimental, beta, production ready

atopal avatar Nov 17 '20 20:11 atopal

Proposing form content below ... @atopal @autonome, would appreciate your blessing on this. Note that it includes some decision-making on legacy issues that have been hanging out in this repo for a while (referenced inline below).

  1. (Display only, no user choice) Display the Awesome IPFS content policy; ideally the policy text would be piped in from the Markdown document so future changes to the policy appear seamlessly in both the markdown doc and the form.

  2. (Single-line text entry, required) Name of your submission (this is what will appear as the title of your item's card)

  3. (Multi-line text entry, required - max 250 characters) Brief description

  4. (Single-line text entry fields, validated as real URIs, at least one is required) Links to:

    • Website
    • Code repository
  5. (Upload prompt with preview, optional) Image (this will be the "teaser" image on your item's card, so choose something that displays well at a small size and encourages the reader to click to learn more) NOTE: Ideally this would include an interface for the user to crop/scale image to fit standardized dimension/aspect ratio (let's say square). If this is too complex, let's discuss alternatives.

  6. (Single-item select, required) (see https://github.com/ipfs/awesome-ipfs/issues/330) Primary category (what type of awesome thing is your submission?):

    • App or website built on or using IPFS
      • (Displays if selected, yes/no, required) Is it open source?
    • Service built on or using IPFS
      • (Displays if selected, yes/no, required) Is it open source?
    • Developer tool or resource
      • (Displays if selected, yes/no, required) Is it open source?
    • Dataset published on IPFS:
    • Educational resource:
      • Video
      • Tutorial or other instructional article
      • Academic paper
    • Something else
      • (Displays if selected, single-line text entry, required) Please describe.
  7. (Displays if category selected above is NOT "educational resource", single-item select, required) How production-ready is your item?

    • Experimental or alpha
    • Beta
    • Production-ready
  8. (Displays if category selected above is NOT "educational resource", single-item select, required) What subject/focus area(s) does your item fit into? Select all that apply.

    • Developer tools and resources
    • Mobile apps/services/tools
    • Internet of things (IoT) apps/services/tools
    • Content providers/CDNs (including hosting)
    • Streaming
    • E-commerce and/or marketplaces
    • Non-fungible tokens (NFTs)
    • Decentralized finance (DeFi) and/or exchanges
    • Social media
    • Prediction and/or gaming
    • Virtual and/or augmented reality (VR/AR)
    • Decentralized and/or self-sovereign identity
    • Data governance
    • Data persistence and/or archiving (including IPFS pinning)
    • Data collaboration
    • Data markets
    • Machine learning
    • Community, mesh, or offline-first networks
    • Something else
      • (Displays if selected, single-line text entry, required) Please describe.
  9. (Single-line text entry, validated as email, optional) Contact email (this will NOT be displayed on awesome.ipfs.io or shared outside of the IPFS core team; we'll only use it if we have questions about your item or any collaborative opportunities)

jessicaschilling avatar Nov 24 '20 19:11 jessicaschilling

For #6 it might make sense to give an "other" option. Other than that, looks good to me :)

atopal avatar Nov 25 '20 14:11 atopal

  1. (Upload prompt with preview, optional) Image (this will be the "teaser" image on your item's card, so choose something that displays well at a small size and encourages the reader to click to learn more)

should provide a specific requirement and/or crop to fit?

  1. (Displays if category selected above is NOT "educational resource", single-item select, required) What subject/focus area(s) does your item fit into? Select all that apply.

should have an "other" option w/ text entry

autonome avatar Nov 25 '20 16:11 autonome

Updated https://github.com/ipfs/awesome-ipfs/issues/367#issuecomment-733188155 to account for @autonome and @atopal comments.

jessicaschilling avatar Nov 25 '20 18:11 jessicaschilling

Closing this is favour of the simpler approach proposed by #478

2color avatar Sep 21 '23 14:09 2color