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

Removes Discovery & Transfer redundancy in Bitswap #1045

Closed
wants to merge 10 commits into from
Closed

Removes Discovery & Transfer redundancy in Bitswap #1045

wants to merge 10 commits into from

Conversation

Annamarie2019
Copy link
Contributor

@Annamarie2019 Annamarie2019 commented Feb 23, 2022 •
edited
Loading

Issue #1042. In Transfer paragraph, removes redundant steps that belong in Discovery only. Moves what happens if no peer has the block from Discovery to Transfer (better to have it placed after successful transfer).

@Annamarie2019 Annamarie2019 mentioned this pull request Feb 23, 2022
Closed
@Annamarie2019 Annamarie2019 changed the title Remove Discovery & Transfer redundancy in Bitswap Removes Discovery & Transfer redundancy in Bitswap Feb 23, 2022
@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

docs/community/chat.md:

docs/community/contribute/grammar-formatting-and-style.md:

  • The following link returned HTTP status code 302 (Found):
    https://proto.school/events
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://www.meetup.com/members/249142444/
  • The following link returned HTTP status code 405 (Method Not Allowed):
    https://www.grammarly.com/
  • The following link returned HTTP status code 302 (Found):
    https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...n words like center. # The Oxford comma Follow each list of three or more it...
                                           ^^^^^^
  • Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. 
    ...ion: This generally isn't necessary for commonly-encountered acronyms like I...
                                           ^^^^^^^^^^^^^^^^^^^^
  • When ‘Project-specific’ is used as a modifier, it is usually spelled with a hyphen. 
    ...chine (VM), Decentralized Web (DWeb). # Project specific titles When referri...
                                           ^^^^^^^^^^^^^^^^
  • Did you mean the formatting language “Markdown” (= proper noun)? 
    ...the GitHub Flavored Markdown syntax for markdown. This way, all articles dis...
                                           ^^^^^^^^
  • An apostrophe may be missing. 
    ...ders the option to view articles on the docs website  (opens new window) or ...
                                           ^^^^
  • Two consecutive dots 
    ...hem using full relative paths (e.g. use ../ for climbing a directory) and sp...
                                           ^^
  • As a shorter alternative for ‘able to’, consider using “can”. 
    ...ent directly in-repo on GitHub's web UI are able to follow relative links co...
                                           ^^^^^^^^^^^
  • You have started another sentence with ‘We’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...ownlint repository  (opens new window). We highly recommend installing VSCod...
                                           ^^
  • Unpaired symbol: ‘"’ seems to be missing 
    ...italics and surrounded by double quotes ": # Code blocks Tag code blocks wit...
                                           ^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...are presenting: # Command-line examples Write command-line inputs without an...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...raneous information: # Inline code tags Surround directories, file names, an...
                                           ^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...rom Father Christmas. # Unordered lists Use the dash character - for un-numb...
                                           ^^^
  • This phrase is redundant. Consider using “outside”. 
    ...s in code tags: The plus symbol + stays outside of the code tags. # Images T...
                                           ^^^^^^^^^^
  • An apostrophe may be missing. 
    ...ticle, so there is no folder within the images directory for that article. #...
                                           ^^^^^^

docs/concepts/bitswap.md:

  • Possible missing comma found. 
    ...ther peers who want them. # How Bitswap works IPFS breaks up files into chun...
                                           ^^^^^
  • You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. 
    ...ist is a list of CIDs for blocks a peer wants to receive. Each node remember...
                                           ^^^^^^^^

docs/concepts/faq.md:

  • The phrase ‘a lot of’ might be wordy. Consider using “many”, “numerous” or “countless”. 
    ...I start contributing to IPFS? There are a lot of ways you can contribute to ...
                                           ^^^^^^^^
  • Consider using “many”. 
    ...sand contributors around the world from many different projects. There are a...
                                           ^^^^^^^^^^^^^^
  • Possible typo detected. 
    ...ment on many related protocols, such as libp2p and Filecoin, with the aim of...
                                           ^^^^^^

docs/concepts/glossary.md:

  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/libp2p/specs/blob/master/autonat/
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/ipfs/research-CRDT
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein a peer can tell othe...
                                           ^^^^^^
  • Possible missing comma found. 
    ...rs that it has data blocks available. # AutoNAT The libp2p protocol that all...
                                           ^^^^^^^
  • Possible typo detected. 
    ...as data blocks available. # AutoNAT The libp2p protocol that allows a peer t...
                                           ^^^^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ..."Qm". Uses a base 58-encoded multihash, very simple but much less flexible t...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...ons of CID. More about CID v1 # Circuit relay A libp2p term for transport pr...
                                           ^^^^^
  • Possible typo detected. 
    ...ID. More about CID v1 # Circuit relay A libp2p term for transport protocol t...
                                           ^^^^^^
  • Possible missing comma found. 
    ...on  (opens new window). # Circuit relay v2 Truly decentralized relay impleme...
                                           ^^
  • Possible missing comma found. 
    ...ee specification  (opens new window). # Codec A function that encodes or dec...
                                           ^^^^^
  • Possible missing comma found. 
    ...mented as part of Multicodec. # Content addressing A way to store informatio...
                                           ^^^^^^^^^^
  • Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). 
    ...nt addressing A way to store information so a device can retrieve the data b...
                                           ^^^
  • Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. 
    ...eplicated Data Type (CRDT) is a type of specially-designed data structure us...
                                           ^^^^^^^^^^^^^^^^^^
  • Consider using “many”. 
    ... systems, blockchains, and for modeling many different kinds of information....
                                           ^^^^^^^^^^^^^^
  • Before the countable noun ‘of’ an article or a possessive pronoun is necessary. 
    ...claiming certain specific structures of map and assigning them this meaning....
                                           ^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ...AG-PB DAG-PB is a codec that implements a very small subset of the IPLD Data...
                                           ^^^^^^^^^^^^
  • It appears that a comma is missing. 
    ... DAG-PB  (opens new window) # Data model Did you mean IPLD Data Model  (open...
                                           ^^^^
  • Possible missing comma found. 
    ...ubset of the IPFS DHT. More about DHT # DMT Short for Data Model Tree, a ter...
                                           ^^^
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein a connection is open...
                                           ^^^^^^
  • Uncountable nouns are usually not used with an indefinite article. Use simply “transport”. 
    ...entation of dialing and listening forms a transport. # DNSLink DNSLink is a ...
                                           ^^^^^^^^^^^
  • ‘by accident’ might be wordy. Consider a shorter alternative. 
    ...le webpage, website, or service, either by accident or on purpose. # E # F #...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...er by accident or on purpose. # E # F # Filestore An experimental data store...
                                           ^^^^^^^^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...ed when --nocopy is passed to ipfs add. It stores the UnixFS data components...
                                           ^^
  • This phrase is duplicated. You should probably use “Garbage Collection” only once. 
    ...ore about Gateway  (opens new window) # Garbage Collection Garbage Collectio...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...lternative content replication protocol under discussion, similar to Bitswap...
                                           ^^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...raphsync  (opens new window) # H # HAMT-sharding The sharding technique used...
                                           ^^^^^^^^
  • ‘exact same’ might be wordy. Consider a shorter alternative. 
    ...) and returns a fixed-length value. The exact same input data will always ge...
                                           ^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...re numerous hash algorithms. More about Hash # Hole punching A  technique fo...
                                           ^^^^
  • Possible missing comma found. 
    ...hash algorithms. More about Hash # Hole punching A  technique for NAT or fir...
                                           ^^^^^^^^
  • This phrase is duplicated. You should probably use “Information Space” only once. 
    ...arding is not possible. See DCUtR # I # Information Space Information Space ...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • ‘in support of’ might be wordy. Consider a shorter alternative. 
    ...(IPLD) model is a set of specifications in support of decentralized data str...
                                           ^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...ged. More about IPNS # J # JS-IPFS node Runs in the browser with a limited s...
                                           ^^^^
  • This expression is ususally spelled with a hyphen 
    ...SON is a text format that is completely language independent, human-readable...
                                           ^^^^^^^^^^^^^^^^^^^^
  • Possible missing article found. 
    ... JSON  (opens new window) # K # L # LAN Local Area Network (LAN) is a type o...
                                           ^^^^^
  • Possible typo detected. 
    ...ther node. This is opposed to a root. # libp2p The libp2p project is a modul...
                                           ^^^^^^
  • Possible typo detected. 
    ...This is opposed to a root. # libp2p The libp2p project is a modular system o...
                                           ^^^^^^
  • Possible typo detected. 
    ...essential component of IPFS. More about libp2p  (opens new window) # Listeni...
                                           ^^^^^^
  • Possible typo detected. 
    ...unction of the IPFS networking layer in libp2p, wherein an incoming connecti...
                                           ^^^^^^
  • Uncountable nouns are usually not used with an indefinite article. Use simply “transport”. 
    ...entation of dialing and listening forms a transport. # Link In IPFS and IPLD...
                                           ^^^^^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...nsport. # Link In IPFS and IPLD, a link usually means a pointer to some CID....
                                           ^^^^^^^
  • The preposition ‘as’ seems more likely in this position. 
    ... a computer science data structure used at the core of IPFS files/block stor...
                                           ^^
  • The preposition ‘of’ seems more likely in this position. 
    ...lock storage. Merkle-DAGs create a hash to their content, known as a Content...
                                           ^^
  • This phrase is duplicated. You should probably use “Merkle Forest” only once. 
    ...ent Identifier. More about Merkle-DAG # Merkle Forest Merkle Forest is a phr...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • Possible typo detected. 
    ... and future-proof network addresses. In libp2p, it is used in peer addressin...
                                           ^^^^^^
  • Possible missing comma found. 
    ...aring in text. In IPFS, it is used as a prefix specifying the encoding used ...
                                           ^^^^^^
  • Possible missing article found. 
    ...AT service to allow multiple devices in local network (LAN) to access the in...
                                           ^^^^^
  • Possible missing comma found. 
    ...n to another is an edge. # O # P # Path/Address A Path/Address is the method...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...alization. See also Peer as Node # Peer ID A Peer ID is how each unique IPFS...
                                           ^^
  • Possible missing comma found. 
    ...what remote pins are. # Pinning Service API A vendor-agnostic API specificat...
                                           ^^^
  • Possible missing comma found. 
    ...sub  (opens new window) # Q # R # Relay node A means to establish connectivi...
                                           ^^^^
  • Possible typo detected. 
    ...means to establish connectivity between libp2p nodes (e.g., IPFS nodes) that...
                                           ^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ...hunks of a file together. If you have a 600MiB file A, it can be split into ...
                                           ^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ..., and D since the block size of IPFS is 256MiB. The node A that links to eac...
                                           ^^^^^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ... special permissions for data exchange. It is self-certifying because data s...
                                           ^^
  • Possible missing comma found. 
    ...Digital signature  (opens new window) # Substrate A vocabulary term in IPLD,...
                                           ^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...tions from other IPFS peers. More about Swarm addresses # T # Transport In l...
                                           ^^^^^
  • Possible typo detected. 
    ...bout Swarm addresses # T # Transport In libp2p, transport refers to the tech...
                                           ^^^^^^
  • Possible missing comma found. 
    ... garbage-collected. More about UnixFS # Urlstore An experimental data store ...
                                           ^^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ... similar to filestore, but it retrieves blocks contents via a HTTP URL inste...
                                           ^^^^^^
  • Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. 
    ...e, but it retrieves blocks contents via a HTTP URL instead of a local filesy...
                                           ^

docs/concepts/hashing.md:

  • ‘exact same’ might be wordy. Consider a shorter alternative. 
    ...e represented by SHA-1 as: However, the exact same input generates the follo...
                                           ^^^^^^^^^^
  • The plural noun “characteristics” cannot be used with the article “a”. Did you mean “a several important characteristic” or “several important characteristics”? 
    ...eristics Cryptographic hashes come with a several important characteristics:...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • ‘exactly the same’ might be wordy. Consider a shorter alternative. 
    ...- the same input message always returns exactly the same output hash uncorre...
                                           ^^^^^^^^^^^^^^^^
  • Consider using a different adverb to strengthen your wording. 
    ...l change in the message should generate a completely different hash unique -...
                                           ^^^^^^^^^^^^

docs/concepts/how-ipfs-works.md:

  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...e identification via content addressing Content linking via directed acyclic...
                                           ^^^^^^^
  • The phrase ‘look for a book’ is used very frequently. Consider using a less frequent alternative to set your writing apart from others. 
    ... do all the time. For example, when you look for a book in the library, you ...
                                           ^^^^^^^^^^^^^^^
  • For conciseness, consider replacing this expression with an adverb. 
    ... for the internet and on your computer! Right now, content is found by locat...
                                           ^^^^^^^^^
  • Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition. 
    ...now, content is found by location, such as: https://en.wikipedia.org/wiki/Aa...
                                           ^^^
  • Consider using “many”. 
    ..., but you can structure a Merkle DAG in many different ways. For example, Gi...
                                           ^^^^^^^^^^^^^^
  • This phrase is redundant. Consider using “inside”. 
    ...DAG that has many versions of your repo inside of it. To build a Merkle DAG ...
                                           ^^^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ...ew window). Merkle DAGs are a bit of a "turtles all the way down"  (opens ne...
                                           ^^^^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...computer could be represented as a DAG. You can also see, hopefully, how Mer...
                                           ^^^
  • Possible typo detected. 
    ... find content, you ask these peers. The libp2p project  (opens new window) i...
                                           ^^^^^^
  • Possible typo detected. 
    ...o each other. (Note that, as with IPLD, libp2p can also be used as a tool fo...
                                           ^^^^^^
  • Possible typo detected. 
    ...s (routing). So, to get to content, use libp2p to query the DHT twice. You'v...
                                           ^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...are other content replication protocols under discussion  (opens new window)...
                                           ^^^^^^^^^^^^^^^^
  • ‘under discussion’ might be wordy. Consider a shorter alternative. 
    ...ns new window). There's also a proposal under discussion to extend the Bitsw...
                                           ^^^^^^^^^^^^^^^^
  • Possible typo detected. 
    ...e Content Identifiers are not hashes. # Libp2p What makes libp2p especially ...
                                           ^^^^^^
  • Possible typo detected. 
    ...ers are not hashes. # Libp2p What makes libp2p especially useful for peer-to...
                                           ^^^^^^
  • Reduce redundancy by only using “bit”. 
    ...to talk to each other about, you send a little bit of each thing, and the ot...
                                           ^^^^^^^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...ogether by generating IPLD Merkle DAGs. You can discover content using a DHT...
                                           ^^^
  • Possible typo detected. 
    ... content using a DHT that's provided by libp2p, open a connection to any pro...
                                           ^^^^^^

docs/concepts/immutability.md:

  • Possible missing comma found. 
    ...th is C. If we request content from the pointer we get back new content sinc...
                                           ^^^^^^^
  • Consider using a different adverb to strengthen your wording. 
    ...nt since the pointer is now pointing at a completely different node. Node B ...
                                           ^^^^^^^^^^^^
  • Possible missing comma found. 
    ...is is different from location-addressed systems where we could reuse the ori...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...view the site. If we change string_2 to IPFS then the CID of the website cha...
                                           ^^^^

docs/concepts/nodes.md:

  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...he IPFS docs, issues, and related code. It's a very general term, so its mea...
                                           ^^
  • Possible typo detected. 
    ...s of nodes: IPFS nodes, data nodes, and libp2p nodes for applications. IPFS ...
                                           ^^^^^^
  • You have started another sentence with ‘They’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...an exchange data with other IPFS nodes. They go by several different names, ...
                                           ^^^^
  • Consider using “several”. 
    ... data with other IPFS nodes. They go by several different names, but we refe...
                                           ^^^^^^^^^^^^^^^^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ... to an individual point on the network. It's a very general term. For exampl...
                                           ^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... peer to other peers.See Observe peers, Exchange files between nodes, and Pe...
                                           ^^^^^^^^
  • As a shorter alternative for ‘able to’, consider using “can”. 
    ...talking about a library or program that is able to communicate with other IP...
                                           ^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...g below for node specifics. Data nodes, Use data nodes when talking about ac...
                                           ^^^
  • Possible typo detected. 
    ...IPLD) model docs, which is in progress. libp2p peer Use libp2p peer when tal...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...docs, which is in progress. libp2p peer Use libp2p peer when talking about l...
                                           ^^^
  • Possible typo detected. 
    ..., which is in progress. libp2p peer Use libp2p peer when talking about libp2...
                                           ^^^^^^
  • Possible typo detected. 
    ...peer Use libp2p peer when talking about libp2p nodes on which you can build ...
                                           ^^^^^^
  • Possible typo detected. 
    ...They're usually referred to as peers in libp2p, because it provides solution...
                                           ^^^^^^
  • If the ‘because’ clause is essential to the meaning, do not use a comma before the clause. 
    ...e usually referred to as peers in libp2p, because it provides solutions for ...
                                           ^^^^^^^^^
  • Possible typo detected. 
    .... JS-ipfs nodes remain connected to the libp2p swarm ports of all preload no...
                                           ^^^^^^
  • Possible typo detected. 
    ... bootstrap nodes, so they will maintain libp2p swarm connections to them at ...
                                           ^^^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...at long. However, this is configurable. You can run nodes with customized po...
                                           ^^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...hat's all the refs command understands. It's harder to find non-dag-pb conte...
                                           ^^
  • Possible missing comma found. 
    ...Can be either Go-IPFS or JS-IPFS nodes; however there are standalone impleme...
                                           ^^^^^^^
  • The preposition ‘with’ is not usually used with the verb ‘talk’. Consider using ‘speak’ instead, or replacing the preposition. 
    ...e with WebSockets/webRTC transports can talk with a Go-IPFS node that only c...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...rable in go-ipfs; uses a preset list of relays See p2p-circuit relay  (opens...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...c DHT if it were to restart. More about Bootstrapping # Delegate routing nod...
                                           ^^^^^^^^^^^^^
  • Possible typo detected. 
    ... bootstrap nodes, so they will maintain libp2p swarm connections to them at ...
                                           ^^^^^^

docs/how-to/best-practices-for-nft-data.md:

  • The following link returned HTTP status code 302 (Found):
    https://proto.school/content-addressing
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://pinata.cloud
  • ‘making a plan’ might be wordy. Consider a shorter alternative. 
    ...ld use each one. Finally, we'll see why making a plan for your data's persis...
                                           ^^^^^^^^^^^^^
  • It seems that a comma is missing. 
    .... # Types of IPFS links and when to use them There are a few different ways ...
                                           ^^^^
  • Consider adding a comma. 
    ...Types of IPFS links and when to use them There are a few different ways to r...
                                           ^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ... use the following options for the ipfs.add method: If you already have a ve...
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...s that are wrapped in a directory, ipfs.add returns the CID of the directory...
                                           ^^^
  • Possible missing comma found. 
    ...es are temporary and will eventually be deleted unless the user decides to "...
                                           ^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...nning a CID tells IPFS that the data is important and shouldn't be removed w...
                                           ^^^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...a platform using IPFS for storage, it's important to pin your data to IPFS n...
                                           ^^^^^^^^^
  • ‘Pinata’ is an imported foreign expression, which originally has a diacritic. Consider using “piñata”. 
    ...g service. Remote pinning services like Pinata  (opens new window) and Etern...
                                           ^^^^^^
  • Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’. 
    ...  (opens new window) provide redundant, highly-available storage for your IP...
                                           ^^^^^^^^^^^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...col Labs  (opens new window) called nft.storage  (opens new window) to get y...
                                           ^^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...ural artifacts that NFTs represent, nft.storage  (opens new window) provides...
                                           ^^^^^^^
  • The preposition ‘to’ seems more likely in this position. 
    ...ns: Use IPFS URIs as the canonical form of link to data on IPFS, for example...
                                           ^^

docs/how-to/command-line-quick-start.md:

  • Possible missing comma found. 
    ...reference implementation written in Go. TIP Don’t want to use the command li...
                                           ^^^
  • The word ‘install’ is not a noun. 
    ...e not yet installed Go-IPFS, follow the install instructions. # Initialize t...
                                           ^^^^^^^
  • The phrase ‘a lot of’ might be wordy. Consider using “many”, “numerous” or “countless”. 
    ...oing so will prevent IPFS from creating a lot of data center-internal traffi...
                                           ^^^^^^^^
  • This abbreviation for “identification” is spelled all-uppercase. 
    ...nd and connect to you. You can run ipfs id at any time to get it again if yo...
                                           ^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...s id at any time to get it again if you need it. Now, try running the comman...
                                           ^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...ooks like ipfs cat /ipfs/<HASH>/readme. You should see something like this: ...
                                           ^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... your computer. The gateway queried the Distributed hash table (DHT), found ...
                                           ^^^^^^^^^^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...ur gateway is not exposed to the world. It only works locally. # Web console...
                                           ^^
  • You have started another sentence with ‘It’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...relying on or trusting remote gateways. It runs in Firefox (desktop and Andr...
                                           ^^
  • You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. 
    ...ges. # Check that FUSE is installed You need to install and set up FUSE in o...
                                           ^^^^^^^
  • Consider a shorter alternative to avoid wordiness. 
    ...led You need to install and set up FUSE in order to mount the file system. F...
                                           ^^^^^^^^^^^

docs/how-to/companion-window-ipfs.md:

  • The following link returned HTTP status code 301 (Moved Permanently):
    Meta: window.ipfs v2 ipfs-companion#589
  • The following link returned HTTP status code 301 (Moved Permanently):
    Expose IPFS API as window.ipfs ipfs-companion#330
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/ipfs/js-ipfs-http-client
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/tableflip/ipfs-postmsg-proxy
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/ipfs-shipyard/ipfs-companion/blob/master/examples/window.ipfs-fallback.html
  • The following link returned HTTP status code 504 (Gateway Timeout):
    https://ipfs.io/ipfs/QmTegrragyzfFq6DSuUaPYoKzm4eRBj2tgQaDHC72dLLaV/
  • The following link returned HTTP status code 301 (Moved Permanently):
    https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...ew window), as of October 19, 2020, and Remove legacy window.ifps  (opens ne...
                                           ^^^^^^
  • Possible missing article found. 
    ...e changes of this interface. It reduces amount of code needed to implement a...
                                           ^^^^^^
  • An apostrophe may be missing. Consider inserting a curly or a straight apostrophe. (Some terms such as “farmers’ market” have a possessive apostrophe after the first noun.) 
    ...denied for a specific command, then the permissions list is present and incl...
                                           ^^^^^^^^^^^
  • An apostrophe may be missing. Consider inserting a curly or a straight apostrophe. (Some terms such as “farmers’ market” have a possessive apostrophe after the first noun.) 
    ...roxy was disabled by the user, then the permissions list is missing entirely...
                                           ^^^^^^^^^^^
  • The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’). 
    ...les you to obtain an IPFS API instance. Depending how IPFS Companion is conf...
                                           ^^^^^^^^^
  • Possible missing article found. 
    ...ntially others in the future. Note that object returned by window.ipfs.enabl...
                                           ^^^^^^
  • For conciseness, consider replacing this expression with an adverb. 
    .... # What about IPFS node configuration? Right now, access to the config comm...
                                           ^^^^^^^^^
  • As a shorter alternative for ‘able to’, consider using “can”. 
    ...ontrol (ACL)? Yes. IPFS Companion users are able to selectively control acce...
                                           ^^^^^^^^^^^
  • You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. 
    ... confirm every API call? Command access needs to be confirmed only once per ...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...ble to call previously whitelisted IPFS commands and users will not be promp...
                                           ^^^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...f permissions. For example: Allow files.add to https://domain.com/ ...will a...
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...https://domain.com/ ...will allow files.add to: https://domain.com/file http...
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...in.com/sub/paths/files etc. Allow files.add to https://domain.com/feature .....
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    .../domain.com/feature ...will allow files.add to: https://domain.com/feature/f...
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ....will cause additional prompt for files.add to: https://domain.com/ https://...
                                           ^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...lication is running. For example: files.write to /myfile.txt on https://doma...
                                           ^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...dapps/https/domain.com/myfile.txt files.write to /path/to/myfile.txt on http...
                                           ^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...in.com/feature/path/to/myfile.txt files.read from /feature/path/to/myfile.tx...
                                           ^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...in.com/feature/path/to/myfile.txt files.stat to / on https://domain.com/feat...
                                           ^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...s /dapps/https/domain.com/feature files.read from /../myfile.txt on https://...
                                           ^^^^
  • Two consecutive dots 
    ...tps/domain.com/feature files.read from /../myfile.txt on https://domain.com/...
                                           ^^

docs/how-to/configure-node.md:

  • Possible missing comma found. 
    ...rofile apply command. When a profile is applied a backup of the configuratio...
                                           ^^^^^^^
  • As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. 
    ... should use this datastore if: You need a very simple and very reliable data...
                                           ^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...ou need a very simple and very reliable datastore you and trust your filesys...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...ck as a separate file in the underlying filesystem so it's unlikely to lose ...
                                           ^^^^^^^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ... issue with the underlying file system. You need to run garbage collection o...
                                           ^^^
  • Do you wish to insert an arrow? 
    ...d to run garbage collection on a small (<= 10GiB) datastore. The default dat...
                                           ^^
  • Insert a space between the numerical value and the unit symbol. 
    ...o run garbage collection on a small (<= 10GiB) datastore. The default datast...
                                           ^^^^^
  • You have started another sentence with ‘You’ nearby. Consider replacing or removing it to add variety to your writing. 
    ...of data behind when garbage collecting. You're concerned about memory usage....
                                           ^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...ult configuration, badger can use up to several gigabytes of memory. This pr...
                                           ^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...ace when your datastore is smaller than several gigabytes. If you run IPFS w...
                                           ^^^^^^^
  • Try using a more formal synonym here to elevate your writing. 
    ...ed block-level garbage collection), you plan on storing very little data in ...
                                           ^^^^^^^^^^^^^^^
  • This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional. 
    ...using flatfs. This datastore uses up to several gigabytes of memory. This pr...
                                           ^^^^^^^
  • If a new sentence starts here, add a space and start with an uppercase letter. 
    ...es to be used by this node. # Addresses.API Multiaddr or array of multiaddrs...
                                           ^^^
  • Do you wish to insert an arrow? 
    ...mple: Default: null Type: object[string -> array[string]] (header names -> a...
                                           ^^
  • Do you wish to insert an arrow? 
    ...[string -> array[string]] (header names -> array of header values) # AutoNAT...
                                           ^^
  • The verb after “to” should be in the base form. 
    ...fault), the AutoNAT service defaults to enabled. Otherwise, this field can t...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... for the above limits. Default: 1m0s (1 Minute) Type: duration (when set to ...
                                           ^^^^^^
  • Consider a shorter alternative to avoid wordiness. 
    ...ltiaddrs of trusted nodes to connect to in order to initiate a connection to...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...the on-disk storage system. # Datastore.StorageMax A soft upper limit for th...
                                           ^^^^^^^^^^
  • Insert a space between the numerical value and the unit symbol. 
    ... if --enable-gc flag is set). Default: "10GB" Type: string (size) # Datastor...
                                           ^^^^
  • Possible missing comma found. 
    ...use increased CPU utilization. Default: false Type: bool # Datastore.BloomFi...
                                           ^^^^^
  • Possible missing comma found. 
    .... Default: false Type: bool # Datastore.BloomFilterSize A number representin...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... in bits. Remember to convert the value m from bits, into bytes for use as B...
                                           ^
  • The abbreviation “e.g.” (= for example) requires two periods. 
    ...astores to provide extra functionality (eg metrics, logging, or caching). Th...
                                           ^^
  • Consider shortening this phrase to just “whether”. It is correct though if you mean ‘regardless of whether’. 
    ...covery.MDNS.Enabled A boolean value for whether or not mdns should be active...
                                           ^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ... fetch files from the network. Default: false Type: bool # Gateway.NoDNSLink...
                                           ^^^^^
  • Possible missing comma found. 
    ...rk. Default: false Type: bool # Gateway.NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Possible missing article found. 
    ...ld be performed. If DNSLink is present, content path stored in the DNS TXT r...
                                           ^^^^^^^
  • Possible missing article found. 
    ...in the DNS TXT record becomes the / and respective payload is returned to th...
                                           ^^^^^^^^^^
  • Do you wish to insert an arrow? 
    ...responses. Default: Type: object[string -> array[string]] # Gateway.RootRedi...
                                           ^^
  • Possible missing comma found. 
    ...ject[string -> array[string]] # Gateway.RootRedirect A url to redirect reque...
                                           ^^^^^^^^^^^^
  • Possible missing comma found. 
    ...efault: "" Type: string (url) # Gateway.Writable A boolean to configure whet...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...e gateway is writeable or not. Default: false Type: bool # Gateway.PathPrefi...
                                           ^^^^^
  • Did you mean “mount a blog”? 
    ...tend http proxy like nginx. Example: We mount blog.ipfs.io (a dnslink page) ...
                                           ^^^^^^^^^^
  • Possible missing comma found. 
    ...se Type: bool # Gateway.PublicGateways: NoDNSLink A boolean to configure whe...
                                           ^^^^^^^^^
  • Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. 
    ...se proxy that provides TLS, make it add a X-Forwarded-Proto: https HTTP head...
                                           ^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...of the box unless set to true manually) Hardened, site-specific DNSLink gate...
                                           ^^^^^^^^
  • Possible missing comma found. 
    ...oDNSLink": true,  # Identity # Identity.PeerID The unique PKI identity label...
                                           ^^^^^^
  • The demonstrative ‘this’ may not agree with the plural noun ‘configs’. Did you mean “these”? 
    ...eerID The unique PKI identity label for this configs peer. Set on init and n...
                                           ^^^^
  • Possible missing comma found. 
    ...time. Type: string (peer ID) # Identity.PrivKey The base64 encoded protobuf ...
                                           ^^^^^^^
  • It seems likely that a singular genitive (’s) apostrophe is missing. 
    ...rotobuf describing (and containing) the nodes private key. Type: string (bas...
                                           ^^^^^
  • Possible missing comma found. 
    ...: string (base64 encoded) # Ipns # Ipns.RepublishPeriod A time duration spec...
                                           ^^^^^^^^^^^^^^^
  • Possible missing comma found. 
    ...an empty string for the default. # Ipns.RecordLifetime A time duration speci...
                                           ^^^^^^^^^^^^^^
  • If this is a compound adjective that modifies the following noun, use a hyphen. 
    ...for managing that service's interest in longer term data storage. The expose...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...elevant to utilizing the remote pinning service Example: # Pinning.RemoteSer...
                                           ^^^^^^^
  • ‘cafes’ is an imported foreign expression, which originally has a diacritic. Consider using “cafés”. 
    ...th a set of pinning services or textile cafes/hubs. A set of friends may pee...
                                           ^^^^^
  • Did you mean “very”? 
    ...tected by both nodes and will likely be vary stable. When asymmetric, only o...
                                           ^^^^
  • Possible missing comma found. 
    ...eering to not overload peers. # Peering.Peers The set of peers with which to...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...e: array[peering] # Reprovider.Strategy Tells reprovider what should be anno...
                                           ^^^^^
  • Style-wise, it’s not ideal to insert an adverb (‘explicitly’) in the middle of an infinitive construction (‘to connect’). Try moving the adverb to avoid split infinitives. 
    ...node will use no routing system. You'll have to explicitly connect to peers ...
                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...source intensive than server mode. When Routing.Type is set to dht, your nod...
                                           ^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...pecific DHT mode, client or server, set Routing.Type to dhtclient or dhtserv...
                                           ^^^^^^^
  • Possible missing comma found. 
    ...erver, set Routing.Type to dhtclient or dhtserver respectively. Please do no...
                                           ^^^^^^^^^
  • Possible missing comma found. 
    ...ions for configuring the swarm. # Swarm.AddrFilters An array of addresses (m...
                                           ^^^^^^^^^^^
  • Possible missing comma found. 
    ...DisableBandwidthMetrics A boolean value that when set to true, will cause ip...
                                           ^^^^
  • Possible missing comma found. 
    ...s a reduction in memory usage. Default: false Type: bool # Swarm.DisableNatP...
                                           ^^^^^
  • Possible missing comma found. 
    ...ible from the public internet. Default: false Type: bool # Swarm.DisableRela...
                                           ^^^^^
  • Possible missing comma found. 
    ...ions from nodes behind relays. Default: false Type: bool # Swarm.EnableRelay...
                                           ^^^^^
  • The preposition ‘to’ seems more likely in this position. 
    ...lay "hop". A relay "hop" relays traffic for other peers. WARNING: Do not ena...
                                           ^^^
  • Possible missing comma found. 
    ...th. There is no rate-limiting. Default: false Type: bool # Swarm.EnableAutoR...
                                           ^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...If Swarm.EnableAutoRelay is enabled and Swarm.EnableRelayHop is disabled, yo...
                                           ^^^^^
  • Possible missing comma found. 
    ...same time. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceM...
                                           ^^^^^^^
  • Consider adding a comma here. 
    ...me. # Swarm.EnableAutoNATService REMOVED Please use [AutoNAT.ServiceMode][]....
                                           ^^^^^^^
  • Possible typo detected. 
    ...rm.Transports Configuration section for libp2p transports. An empty configur...
                                           ^^^^^^
  • Possible typo detected. 
    ...ports.Network Configuration section for libp2p network transports. Transport...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...s for these transports must be added to Addresses.Swarm. Supported transport...
                                           ^^^^^^^^^
  • Possible typo detected. 
    ...port encryption and/or multiplexing, so libp2p will layer a security & multi...
                                           ^^^^^^
  • Possible typo detected. 
    ...fault) # Swarm.Transports.Network.Relay Libp2p Relay  (opens new window) pro...
                                           ^^^^^^
  • Possible typo detected. 
    ...connections by hopping between multiple libp2p nodes. This transport is prim...
                                           ^^^^^^
  • Possible typo detected. 
    ...orts.Security Configuration section for libp2p security transports. Transpor...
                                           ^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... SECIO (Disabled: i.e. priority false), Noise (priority 300). No default pri...
                                           ^^^^^
  • Possible typo detected. 
    ...w) was the most widely supported IPFS & libp2p security transport. However, ...
                                           ^^^^^^
  • Possible missing comma found. 
    ... protocols like TLS and Noise. Default: false Type: priority # Swarm.Transpo...
                                           ^^^^^
  • Possible typo detected. 
    ...lace TLS as the cross-platform, default libp2p protocol due to ease of imple...
                                           ^^^^^^
  • Possible typo detected. 
    ....Multiplexers Configuration section for libp2p multiplexer transports. Trans...
                                           ^^^^^^
  • Possible typo detected. 
    ... between go-ipfs and all other IPFS and libp2p implementations. Unlike Yamux...
                                           ^^^^^^
  • The verb form ‘specifies’ does not seem to match the subject ‘values’. 
    ... Unlike Yamux: The mounts config values specifies the default mount points f...
                                           ^^^^^^^^^

docs/how-to/websites-on-ipfs/static-site-generators.md:

  • The following link returned HTTP status code 302 (Found):
    https://blog.fleek.co/posts/wordpress+fleek
  • Possible missing comma found. 
    ...tall and set up your project. In config.toml add relativeURLS and set it to ...
                                           ^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ... and set it to true. Build static pages Output will be in ./public/ director...
                                           ^^^^^^
  • Possible missing preposition found. 
    ... using all-relative  (opens new window) Upload the dist folder to IPFS. # Mi...
                                           ^^^^^^
  • Possible missing preposition found. 
    ... dist folder to IPFS. # Middleman Refer the Middleman's Installation  (opens...
                                           ^^^
  • Did you mean the formatting language “Markdown” (= proper noun)? 
    ...s generated by the link_to helper or by markdown will become relative. Build...
                                           ^^^^^^^^
  • Possible missing preposition found. 
    ... using all-relative  (opens new window) Upload the _site folder to IPFS. # W...
                                           ^^^^^^

docs/install/ipfs-desktop.md:

  • The following link returned HTTP status code 302 (Found):
    https://community.chocolatey.org/packages/ipfs-desktop
  • The following link returned HTTP status code 307 (Temporary Redirect):
    https://aur.archlinux.org/packages/ipfs-desktop/
  • This phrase is duplicated. You should probably use “IPFS Desktop” only once. 
    # IPFS Desktop IPFS Desktop bundles an IPFS node, file manager, pee...
  ^^^^^^^^^^^^^^^^^^^^^^^^^
  • Only proper nouns start with an uppercase character (there are exceptions for headlines). 
    ...nubar/taskbar      # Feature highlights Start your node at system startup (M...
                                           ^^^^^
  • The word ‘install’ is not a noun. 
    ...n the computer. Click Next:  Select the install location for the application...
                                           ^^^^^^^
  • A word may be missing after ‘the’. 
    ...window). Move into where you downloaded the .AppImage file, and make it exec...
                                           ^^^^^
  • A word may be missing after ‘the’. 
    ...age file, and make it executable:  Open the .AppImage by calling ./ipfs-desk...
                                           ^^^^^
  • A word may be missing after ‘the’. 
    ...from the command-line: You can also run the .AppImage file by double-clickin...
                                           ^^^^^

@johnnymatthews
Copy link
Contributor

This PR seems to include changes you've made on other PRs: #1025 https://github.com/ipfs/ipfs-docs/pull/1031/files

Before you make a new PR, checkout to the main, pull in the latest changes, and then make a branch. This will ensure that you're only making suggestions from the main branch, and not a working branch you have locally. I'm going to close this PR. I can walk you through the process over a call if you need.

@Annamarie2019
Copy link
Contributor Author

Thanks, Johnny. I wrote that into my steps now, so I should remember it going forward.

@Annamarie2019 Annamarie2019 deleted the bitswap-redundancy branch February 27, 2022 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Annamarie2019 @filecorgi @johnnymatthews