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.

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

What is IPFS? Rewrite and make consistent in the docs. #1434

Closed
1 of 3 tasks
TMoMoreau opened this issue Jan 23, 2023 · 4 comments
Closed
1 of 3 tasks

What is IPFS? Rewrite and make consistent in the docs. #1434

TMoMoreau opened this issue Jan 23, 2023 · 4 comments
Assignees
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or an improvement to an existing feature P1 High: Likely tackled by core team if no one steps up

Comments

@TMoMoreau
Copy link
Contributor

TMoMoreau commented Jan 23, 2023

Original issue here: #1368
Original comment bringing this issue to light: #1363 (comment)
Useful write-up on Notion by @2color about this topic: https://www.notion.so/What-is-IPFS-Definitions-02d37b91f6824bba8c246fdcd5021a5c

Opening a new issue for this, both to bring it back into priority and to expand the original scope. This issue will track all the pages that need to be updated, and will serve as a place of discussion around the topic.

There are a few pages in the docs that need to be rewritten to give a more accurate description and introduction to IPFS.

Pages that need to be updated:

@TMoMoreau TMoMoreau added P1 High: Likely tackled by core team if no one steps up kind/enhancement A net-new feature or an improvement to an existing feature dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week labels Jan 23, 2023
@TMoMoreau TMoMoreau self-assigned this Jan 23, 2023
@TMoMoreau
Copy link
Contributor Author

TMoMoreau commented Jan 23, 2023

Regarding the landing page: There's a line in the introduction that says, "Some call IPFS the hard drive for blockchain and Web3." I believe this is going to be removed, as I feel it only reinforces the misconception that IPFS is a storage solution. (And beyond that, may also reinforce the misconception that IPFS is/has a blockchain?)

@2color @ElPaisano Open for discussion about this, as well as anything else related to the topic.

@ElPaisano
Copy link
Contributor

@TMoMoreau RE

Pages that need to be updated:

The more I look into the basic concepts rewrite issue #1433, the more I'm convinced it will involve some sort of rewrite / consolidation of "what is IPFS?" and "How IPFS works". So, I'd say it would be best to lump the definition updates work for those two pages into #1433 since they're related.

As for the landing page, I think that's a great first sub-issue to tackle in this epic, and issue 1433 can be worked on at the same time and should address the definition work for "What is IPFS" and "How IPFS works"

I'll look around for other pages we might want to update

@TMoMoreau
Copy link
Contributor Author

Makes sense to me. Only important thing is, if you plan on including rewritten definitions of IPFS in the concepts rewrite you have going, we just need to make sure it is consistent with the landing page definition I'm working on.

@ElPaisano
Copy link
Contributor

Makes sense to me. Only important thing is, if you plan on including rewritten definitions of IPFS in the concepts rewrite you have going, we just need to make sure it is consistent with the landing page definition I'm working on.

Good callout @TMoMoreau. Where can I find the PR link for the rewrite so I can take a look at that definition?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or an improvement to an existing feature P1 High: Likely tackled by core team if no one steps up
Projects
None yet
Development

No branches or pull requests

2 participants