Glossary document

[marlowe]

It has been stated that the documentation is very difficult for a new user. As discussed in IRC, the introduction of glossary document defining new or Tahoe specific terms may provide some clarity to the user. For example, terms a new user may be unfamiliar with include capability, furl and introducer.

[marlowe]

Terms to include:

nodes WUI WAPI erasure-code gateway capability shares mutable/immutable

[davidsarah]

• read-only
• storage {client,server,protocol}
• foolscap
• furl
• introducer
• key generator
• stats gatherer
• log gatherer
• object (= Tahoe file or directory)
• share
• dircap, filecap, write cap, read cap, verify cap
• Tahoe URI

I think "web-API" is preferred over WAPI.

[davidsarah]

It also occurred to me that translating the glossary first, might be helpful to the translation effort for each language, to ensure consistency.

[davidsarah]

Replying to davidsarah:

It also occurred to me that translating the glossary first, might be helpful to the translation effort for each language, to ensure consistency.

and to double as a technical dictionary of English <-> target language for end-users.

[amontero]

Be aware that the term "client" is ambiguously used as a "client (to gateway) program" and as a gateway node.

This has been filed as #2127, and it could benefit of an appropiate glossary.