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

fix: glossary link to better gateway docs #1098

Merged
merged 1 commit into from
Mar 29, 2022

Conversation

lidel
Copy link
Member

@lidel lidel commented Mar 26, 2022

Linking to the same docs as in ipfs/kubo#8825

@filecorgi
Copy link
Contributor

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

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...
                                               ^^^^^^^^^
    
  • This phrase is duplicated. You should probably use “Garbage Collection” only once.
    ...ateway and addressing IPFS on the web # 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...
                                               ^^^^^^
    
  • 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...
                                               ^
    

Copy link
Contributor

@johnnymatthews johnnymatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh sorry for the delay in reviewing this one. Looks good!

@johnnymatthews johnnymatthews merged commit b6b54ea into main Mar 29, 2022
@johnnymatthews johnnymatthews deleted the fix/gateway-glossary-link branch March 29, 2022 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants