on master help sign in
Merge pull request #946 from lycurgus/master

Create glossary entry for 'pier'

commit69787148a5b2385ead40eff5c485cd3b1db5dcc6 authorpoprox <51337059+syzygyzer@users.noreply.github.com> dateMon 14 Sep 2020, 17:59 (6 years ago) parentd2f3c156003342
4 files changed+24−1
glossary/breach.md+1−1 glossary/eventlog.md+4 glossary/pier.md+18 glossary/ship.md+1
glossary/breach.md+1−1
@@ -24,7 +24,7 @@ into dojo and pressing Enter.
2424
2525Network breaches happen when a major Arvo revision that cannot be implemented
2626via an [OTA update](../ota-updates) occurs. When this happens, a new binary
27−will need to be downloaded, and your ship's pier needs to be moved to the
27+will need to be downloaded, and your ship's [pier](../pier) needs to be moved to the
2828directory containing the new binary.
2929
3030### Further Reading
glossary/eventlog.md+4
@@ -17,3 +17,7 @@ In practice, event logs become large and unwieldy over time. Periodically a snap
1717Persistence, in the context of storing data in a computer system, means that data is stored in a non-volatile manner and that input must be recorded before the output result is performed. Thus, every event must be written to disk - or must be _persisted_ - before the event effects actually take place.
1818
1919The initial entries of the event log are created during the bootstrap sequence contained in a [Pill](../pill).
20+
21+### Further Reading
22+
23+- [Pier](../pier): The directory on disk which contains the ship's state.
glossary/pier.mdnew file+18
@@ -0,0 +1,18 @@
1++++
2+title = "Pier"
3+template = "doc.html"
4+[extra]
5+category = "arvo"
6++++
7+
8+A **pier** is the directory which contains the state of an Urbit [ship](../ship). It is automatically created in the current directory when booting a ship for the first time.
9+
10+Your pier should be kept safe - if it's deleted, you will need to perform a [breach](../breach) in order to advise the rest of the network that your ship's state has been lost.
11+
12+Note that a backup should usually _not_ be taken of your pier as a means of keeping it safe - once the ship is run on the network, the backup will be outdated and running from it will necessitate a breach. A running ship automatically backs up its own state within the pier directory for recovery purposes, so as long as the pier is preserved, recovery from most problems is possible.
13+
14+### Further Reading
15+
16+- [Event Log](../eventlog): The main important content of the pier directory.
17+- [A Guide to Breaches](@/docs/tutorials/guide-to-breaches.md): Instructions on handling continuity breaches (resets) on the Ames network.
18+- [Ship Troubleshooting](@/docs/tutorials/ship-troubleshooting.md): General instructions on getting your ship to work, which includes network connectivity issues.
glossary/ship.md+1
@@ -23,3 +23,4 @@ To be able to use the Arvo network, planets, stars, and galaxies must be combine
2323- [Using Bridge](@/using/install.md): A guide to installing Urbit and booting a ship.
2424- [Ship Troubleshooting](@/docs/tutorials/ship-troubleshooting.md): General instructions on getting your ship to work, which includes network connectivity issues.
2525- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
26+- [Pier](../pier): The directory containing a ship's state.