isle/docs/dev/glossary.md

26 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

# 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.
- "Isle" - The name of this project, which is a proper noun and so should always
be capitalized.
- "isle" - The name of the binary or program produced by the Isle project. isle
2024-10-03 16:59:48 +00:00
is the name of the file itself, as well as an instance of the process, and so
is always lower-case.
- "host" - A computer or device on which isle is run.
- "isle network", "network" - A collection of hosts which communicate and share
resources with each other via the Isle project.
2024-07-07 11:37:26 +00:00
- "garage cluster" - Garage is one of the sub-processes which isle is able to
run. These garage process connect together to form a cluster. We use the
term "cluster" in the context of garage to stay consistent with garage's
documentation and command-line.
2024-10-03 16:59:48 +00:00
- "member" - A person who takes part in the usage, operation, or administration
of an isle network.