Add Glossary, remove "participant" as a term
This commit is contained in:
parent
46685113e0
commit
bd5a5552bc
27
README.md
27
README.md
@ -20,9 +20,9 @@ The core components of cryptic-net, currently, are:
|
|||||||
the network are on a private LAN (e.g. their home WiFi network) or have a
|
the network are on a private LAN (e.g. their home WiFi network) or have a
|
||||||
dynamic IP, they can still communicate directly with each other.
|
dynamic IP, they can still communicate directly with each other.
|
||||||
|
|
||||||
* An S3-compatible network filesystem. Each participant can provide as much
|
* An S3-compatible network filesystem. Each users can provide as much storage as
|
||||||
storage as they care to, if any. Stored data is sharded and replicated across
|
they care to, if any. Stored data is sharded and replicated across all hosts
|
||||||
all hosts that choose to provide storage.
|
that choose to provide storage.
|
||||||
|
|
||||||
* A DNS server which provides automatic host and service (coming soon) discovery
|
* A DNS server which provides automatic host and service (coming soon) discovery
|
||||||
within the network.
|
within the network.
|
||||||
@ -44,9 +44,9 @@ decide which documents they need to care about.
|
|||||||
|
|
||||||
### User Docs
|
### User Docs
|
||||||
|
|
||||||
Users are participants who use cryptic-net resources, but do not provide any
|
Users are participants who use network resources, but do not provide any network
|
||||||
network or storage resources themselves. Users may be accessing the network from
|
or storage resources themselves. Users may be accessing the network from a
|
||||||
a laptop, and so are not expected to be online at any particular moment.
|
laptop, and so are not expected to be online at any particular moment.
|
||||||
|
|
||||||
Documentation for users:
|
Documentation for users:
|
||||||
|
|
||||||
@ -57,7 +57,7 @@ Documentation for users:
|
|||||||
|
|
||||||
### Operator Docs
|
### Operator Docs
|
||||||
|
|
||||||
Operators are participants who own a dedicated host which they can expect to be
|
Operators are users who own a dedicated host which they can expect to be
|
||||||
always-online (to the extent that's possible in a residential environment).
|
always-online (to the extent that's possible in a residential environment).
|
||||||
Operator hosts will need at least one of the following to be useful:
|
Operator hosts will need at least one of the following to be useful:
|
||||||
|
|
||||||
@ -78,8 +78,8 @@ Documentation for operators:
|
|||||||
|
|
||||||
### Admin Docs
|
### Admin Docs
|
||||||
|
|
||||||
Admins are participants who control membership within the network. They are
|
Admins are users who control membership within the network. They are likely
|
||||||
likely operators as well.
|
operators as well.
|
||||||
|
|
||||||
Documentation for admins:
|
Documentation for admins:
|
||||||
|
|
||||||
@ -89,15 +89,15 @@ Documentation for admins:
|
|||||||
|
|
||||||
### Dev Docs
|
### Dev Docs
|
||||||
|
|
||||||
Devs may or may not be participants in any particular cryptic-net. They instead
|
Devs may or may not be users in any particular cryptic network. They instead are
|
||||||
are those who work on the actual code for cryptic-net.
|
those who work on the actual code for cryptic-net.
|
||||||
|
|
||||||
Documentation for devs:
|
Documentation for devs:
|
||||||
|
|
||||||
* [Design Principles](docs/dev/design-principles.md)
|
* [Design Principles](docs/dev/design-principles.md)
|
||||||
* [`cryptic-net daemon` process tree](docs/dev/daemon-process-tree.svg): Diagram
|
* [`cryptic-net daemon` process tree](docs/dev/daemon-process-tree.svg): Diagram
|
||||||
describing the [pmux](https://code.betamike.com/cryptic-io/pmux) process tree created
|
describing the [pmux](https://code.betamike.com/cryptic-io/pmux) process tree
|
||||||
by `cryptic-net daemon` at runtime.
|
created by `cryptic-net daemon` at runtime.
|
||||||
* [Rebuilding Documentation](docs/dev/rebuilding-documentation.md)
|
* [Rebuilding Documentation](docs/dev/rebuilding-documentation.md)
|
||||||
|
|
||||||
## Misc
|
## Misc
|
||||||
@ -105,5 +105,6 @@ Documentation for devs:
|
|||||||
Besides documentation, there are a few other pages which might be useful:
|
Besides documentation, there are a few other pages which might be useful:
|
||||||
|
|
||||||
* [Roadmap][roadmap]
|
* [Roadmap][roadmap]
|
||||||
|
* [Glossary](docs/glossary.md)
|
||||||
|
|
||||||
[roadmap]: docs/roadmap.md
|
[roadmap]: docs/roadmap.md
|
||||||
|
17
docs/glossary.md
Normal file
17
docs/glossary.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Glossary
|
||||||
|
|
||||||
|
The purpose of this document is define the specific terms which should be used
|
||||||
|
for various concepts, with the goal of establishing consistency throughout
|
||||||
|
documentation and source code.
|
||||||
|
|
||||||
|
- "user" - a person who takes part in the usage, operation, or administration of
|
||||||
|
a cryptic network.
|
||||||
|
|
||||||
|
- "host" - A computer or device used by a user to connect to a cryptic network.
|
||||||
|
|
||||||
|
- "cryptic network", "network" - A collection of hosts which communicate and
|
||||||
|
share resources with each other via the mechanisms provided by the cryptic-net
|
||||||
|
project.
|
||||||
|
|
||||||
|
- "cryptic-net" - The name of the binary or program which is used to interact
|
||||||
|
with a cryptic network.
|
Loading…
Reference in New Issue
Block a user