Cleanup js-ipfs mentions #1620
Cleanup js-ipfs mentions #1620
Conversation
|
@ElPaisano : I'm converting to draft given its WIP. I'm happy to take a look once it has all the changes you intend to make. |
--------- Co-authored-by: Marcin Rataj <lidel@lidel.org> Co-authored-by: ElPaisano <113373882+ElPaisano@users.noreply.github.com>
--------- Co-authored-by: ElPaisano <113373882+ElPaisano@users.noreply.github.com>
|
Hi guys - this has been open for a few weeks. I'd like to find a more incremental approach so we can start removing js-ipfs mentions as we go rather than waiting for it all to be done. |
|
@ElPaisano To address @BigLep's latest comment; How can we get these changes merged in faster? We should merge this now if we can, or do whatever we can do be able to merge this more quickly. |
Strip out all references to embedded.
There was a problem hiding this comment.
I left some comments. I couldn't do "suggestions" because this was already merged. @ElPaisano : are you ok to take on the followup review incorporating this feedback?
| @@ -34,6 +35,20 @@ When you add a file to IPFS, IPFS splits it into smaller blocks. IPFS hashes eac | |||
|
|
|||
| There are a lot of ways you can contribute to IPFS, whether you're interested in helping with either of the core implementations, applications like IPFS Desktop, writing or editing documentation, doing UX, or whatever you enjoy working on. [Get all the details on where to get started here.](../community/contribute/ways-to-contribute.md) | |||
|
|
|||
| ### What is an implementation | |||
There was a problem hiding this comment.
We should really be driving people towards https://specs.ipfs.tech in this section and particularly https://specs.ipfs.tech/architecture/
|
|
||
| - Verifies that the CIDs it resolves match the resources they address, at least when it has access to the resources bytes. However, implementations may relax this requirement in controlled environments in which it is possible to ascertain that verification has happened elsewhere in a trusted part of the system. | ||
|
|
||
| There are already many IPFS implementations, including [Kubo](../install/command-line.md), [Helia](../install/js-ipfs.md), and [more](../concepts/ipfs-implementations.md). |
There was a problem hiding this comment.
I think better to link to the Kubo and Helia project pages.
Also is js-ipfs.md still a thing?
| @@ -228,6 +228,10 @@ The sharding technique used for [sharding](#sharding) big UnixFS directories. It | |||
|
|
|||
| A Cryptographic Hash is a function that takes some arbitrary input (content) and returns a fixed-length value. The exact same input data will always generate the same hash as output. There are numerous hash algorithms. [More about Hash](hashing.md) | |||
|
|
|||
| ### Helia | |||
|
|
|||
| A lean, modular, and modern implementation of IPFS for the JS and browser environments. Superseded [js-ipfs](#js-ipfs). Learn more at [https://github.com/ipfs/helia](https://github.com/ipfs/helia). | |||
There was a problem hiding this comment.
"It supersedes js-ipfs." (so we have a complete sentence)
|
|
||
| #### Limitations of a bootstrap node: | ||
|
|
||
| - If an IPFS node only has one bootstrap node listed in that configuration and that bootstrap node goes offline, the IPFS node will lose access to the public DHT if it were to restart. | ||
| - If an IPFS _node_ only has one bootstrap _node_ listed in that configuration and that bootstrap node goes offline, the IPFS node will lose access to the public DHT if it were to restart. | ||
| - Note that you should be able to configure your _peer_ store in your implementation to cache healthy connectable _peers_ so you can connect to them again after a restart, instead of bootstrap _nodes_. [Kubo recently added support for this](https://github.com/ipfs/kubo/pull/8856). |
There was a problem hiding this comment.
"recent" is relative
I think better to link to the issue which has the context and links to the PR
| @@ -5,7 +5,7 @@ description: Learn about the available node types in IPFS Companion. | |||
|
|
|||
| # Understand node types in IPFS Companion | |||
|
|
|||
| IPFS Companion's preferences screen allows you to choose from several different node types. The available types you'll see in your Companion preferences depends on the browser you're using (i.e. Firefox, Chrome, Brave), but the full list is as follows: | |||
| IPFS Companion's preferences screen allows you to choose from different node types. The available types you'll see in your Companion preferences depends on the browser you're using (i.e. Firefox, Chrome, Brave), but the full list is as follows: | |||
There was a problem hiding this comment.
@whizzzkid or @ElPaisano : per #1631 (comment) , we should update the screenshot here (or just remove the screenshot and referencing text).
| @@ -102,29 +101,3 @@ ipfs name publish --key=SecondKey /ipfs/bafybeicklkqcnlvtiscr2hzkubjwnwjinvskffn | |||
|
|
|||
| > Published to k51qzi5uqu5dh5kbbff1ucw3ksphpy3vxx4en4dbtfh90pvw4mzd8nfm5r5fnl: /ipfs/bafybeicklkqcnlvtiscr2hzkubjwnwjinvskffn4xorqeduft3wq7vm5u4 | |||
| ``` | |||
|
|
|||
| ## Publishing IPNS names programmatically with JS-IPFS | |||
There was a problem hiding this comment.
Maybe give a link to https://github.com/ipfs/helia-ipns for doing IPNS with JS?
(A side issue is that that repo needs to have a usage example: ipfs/helia-ipns#59 )
WIP
As part of #1611, makes changes to ipfs-docs as described for each page in the Actions column of https://pl-strflt.notion.site/ipfs-docs-js-ipfs-cleanup-d46e22253bec4497865c38e7a9277eac
@SgtPooki @whizzzkid you should be able to contribute directly to this PR