Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add content about IPFS in resource constrained environments #1412

Open
5 tasks done
2color opened this issue Jan 16, 2023 · 4 comments · May be fixed by #1450
Open
5 tasks done

Add content about IPFS in resource constrained environments #1412

2color opened this issue Jan 16, 2023 · 4 comments · May be fixed by #1450
Assignees
@ElPaisano
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week need/discussion need/maintainers-input Needs input from the current maintainer(s) P3 Low: Not priority right now status/blocked Unable to be worked further until needs are met

Comments

@2color
Copy link
Member

2color commented Jan 16, 2023 •
edited by ElPaisano
Loading

Background

Many ongoing projects explore how to use IPFS in resource-constrained environments such as mobile devices, web browsers, and IoT devices.

Examples include Aggregore, Durin, and Iroh, Capyloon, and ipfs-embed

These rely on similar patterns, such as HTTP IPFS Gateways and "delegated providing" using pinning services (and the upcoming writeable gateway spec).

Page goal

  • Educate about the resources commonly needed by an IPFS node, e.g. access to TCP/UDP connections, no. of peers, being long-running (to continue publishing to the DHT), be publicly reachable
  • Educate about the trade-offs, how some responsibilities can be delegated, and the landscape of options (delegated routing over HTTP with link to spec), delegated representation and providing pinning services, verified retrieval with gateways.
  • link out to relevant tooling, libraries, and projects working on this.

Tasks

  • Create PR for new page in Concepts section to capture info above with sections and links to the implementations page.
  • Create task list in PR
  • Link PR to this issue
  • Add PR to ipfs docs work board
  • Remove this issue from ipfs docs work board
@2color 2color added need/triage Needs initial labeling and prioritization kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. labels Jan 16, 2023
@ipfs ipfs deleted a comment from welcome bot Jan 16, 2023
@2color 2color mentioned this issue Jan 16, 2023
Merged
3 tasks
@ElPaisano
Copy link
Contributor

@2color this proposal makes sense.

Questions for you:

  1. Do you think we could include all of this info in a single page? From your description, it seems like yes, with more or less one section for each of the bullet points you mentioned
  2. If we condense this into a single page, where should that page go? From your description, this seems to me to be something that would fit into our Concepts category.

@2color
Copy link
Member Author

2color commented Jan 25, 2023

Yeah I would create a new page for this with sections and links to the implementations page.

The concepts section sounds like a good place for this

@ElPaisano ElPaisano self-assigned this Jan 25, 2023
@ElPaisano ElPaisano added need/create-pr and removed need/triage Needs initial labeling and prioritization labels Jan 25, 2023
@ElPaisano ElPaisano linked a pull request Jan 25, 2023 that will close this issue
Draft
3 tasks
@ElPaisano ElPaisano linked a pull request Jan 25, 2023 that will close this issue
Add page in Concepts about IPFS in resource constrained environments #1450
Draft
3 tasks
@ElPaisano
Copy link
Contributor

@2color I started on #1450 (still very much a draft) for this issue. I'll tag you in that PR once it's ready for 👀

@johnnymatthews johnnymatthews moved this to Needs triage in Protocol Docs Feb 6, 2023
@johnnymatthews johnnymatthews added dif/hard Having worked on the specific codebase is important P2 Medium: Good to have, but can wait until someone steps up effort/days Estimated to take multiple days, but less than a week and removed kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. labels Feb 23, 2023
@johnnymatthews johnnymatthews moved this from 👣 Needs triage to 📋 Backlog in Protocol Docs Feb 23, 2023
@johnnymatthews johnnymatthews moved this from 📋 Backlog to 🏗 In Progress in Protocol Docs Feb 23, 2023
@johnnymatthews johnnymatthews moved this from 🏗 In Progress to 📋 Backlog in Protocol Docs Mar 30, 2023
@ElPaisano ElPaisano moved this from 📋 Backlog to 👾 Up next in Protocol Docs Apr 3, 2023
@ElPaisano ElPaisano added P3 Low: Not priority right now need/maintainers-input Needs input from the current maintainer(s) need/discussion and removed P2 Medium: Good to have, but can wait until someone steps up labels Apr 4, 2023
@ElPaisano
Copy link
Contributor

Reached out to team in Slack requesting SME assistance to finish this. No response yet, depriortizing, as the team has not indicated that this PR is important to finish. Will repriortize if I hear back

@ElPaisano ElPaisano added the status/blocked Unable to be worked further until needs are met label Apr 4, 2023
@ElPaisano ElPaisano moved this from 👾 Up next to 📋 Backlog in Protocol Docs Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ElPaisano ElPaisano

Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week need/discussion need/maintainers-input Needs input from the current maintainer(s) P3 Low: Not priority right now status/blocked Unable to be worked further until needs are met
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add page in Concepts about IPFS in resource constrained environments ElPaisano/ipfs-docs
3 participants
@2color @johnnymatthews @ElPaisano