docs: glossary for go-ipfs 0.11 release notes

[lidel]

Added some things that we want to link to from Release Notes drafted in ipfs/kubo#8343 (but also useful on their own).

cc @vyzo @mxinden @marten-seemann for visibility – this adds some libp2p terms to the IPFS glossary at https://docs.ipfs.io/concepts/glossary, please eyeball in spare time in case I misrepresented anything.

[mxinden]

Thanks for the additions @lidel. libp2p related entries look good to me.

that we want to link to from Release Notes

🙏

[johnnymatthews]

How do you even pronounce this? 😅

[vyzo]

deekatar

[lidel]

this is too good to be lost in github comments – can add this to glossary using https://en.wikipedia.org/wiki/International_Phonetic_Alphabet ?

[filecorgi]

• 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/ipfs/research-CRDT
• Possible typo detected.

  ...unction of the IPFS networking layer in libp2p, wherein a peer can tell othe...
                                             ^^^^^^
  

• Only proper nouns start with an uppercase character (there are exceptions for headlines).

  ... other peers on the network. More about Bootstrapping # C # CBOR The Concise...
                                             ^^^^^^^^^^^^^
  

• 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 #...
                                             ^^^^^^^^^^^
  

• 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...
                                             ^^^^^^^^^^^^^
  

• 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 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...
                                             ^^^^^^^
  

• This phrasing can be wordy, try something more concise.

  ...peer-to-peer model of decentralization, as opposed to the client-server mode...
                                             ^^^^^^^^^^^^^
  

• 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 typo detected.

  ...means to establish connectivity between libp2p nodes (e.g., IPFS nodes) that...
                                             ^^^^^^
  

• Only proper nouns start with an uppercase character (there are exceptions for headlines).

  ...rse proxies, firewalls, etc. More about Relay  (opens new window) # Repo The...
                                             ^^^^^
  

• 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...
                                             ^^^^^^
  

[lidel]

I'm assuming this is good enough – @johnnymatthews I'm merging because we shipped Release Notes for 0.11 that depend on this 😅