diff options
author | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-01-20 19:07:38 +0100 |
---|---|---|
committer | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-01-20 19:07:38 +0100 |
commit | 944d1f728cb1612daa51aa2c550c0bcb67166852 (patch) | |
tree | f0a52d10dfbb855da0b1db17f820b4a73bfa8e40 /docs/terminology.md | |
parent | bdb01c2c068df326f5a8328ed1492ab1bea388c5 (diff) | |
download | sink-944d1f728cb1612daa51aa2c550c0bcb67166852.tar.gz sink-944d1f728cb1612daa51aa2c550c0bcb67166852.zip |
Use Sink in docs.
Diffstat (limited to 'docs/terminology.md')
-rw-r--r-- | docs/terminology.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/terminology.md b/docs/terminology.md index 9da8851..1826bec 100644 --- a/docs/terminology.md +++ b/docs/terminology.md | |||
@@ -1,11 +1,11 @@ | |||
1 | Consistent, agreed-upon terminology is key to being able to work together efficiently on a complex software project such as this, particularly as we are building on the earlier Akonadi efforts which itself has established terminology. You can find the current glossary here. | 1 | Consistent, agreed-upon terminology is key to being able to work together efficiently on a complex software project such as this, particularly as we are building on the earlier Akonadi efforts which itself has established terminology. You can find the current glossary here. |
2 | 2 | ||
3 | It is recommended to familiarize yourself with the terms before going further into the design of Akonadi-next as it will make things clearer for you and easier to ask the questions you have in a way that others will understand immediately. | 3 | It is recommended to familiarize yourself with the terms before going further into the design of Sink as it will make things clearer for you and easier to ask the questions you have in a way that others will understand immediately. |
4 | 4 | ||
5 | ## Glossary of Akonadi-Next Terms | 5 | ## Glossary of Sink Terms |
6 | * akonadi1: The current akonadi implementation that uses a central server and an SQL database | 6 | * akonadi1: The current akonadi implementation that uses a central server and an SQL database |
7 | * akonadi-next: This is the codename for the project. In the long run this is supposed to be folded into regular akonadi, so we will never release a product called akonadi-next. | 7 | * Sink: This is the name for the project. |
8 | * client: any application which accesses data using akonadi | 8 | * client: any application which accesses data using Sink |
9 | * entity: The atomic unit for a given type of data. An email is an entity; an email folder is an entity; a calendar event is an entity; a contact is an entity; etc. Different kinds of entities may have their own data structure, but conceptually they are equivalent in most other ways. | 9 | * entity: The atomic unit for a given type of data. An email is an entity; an email folder is an entity; a calendar event is an entity; a contact is an entity; etc. Different kinds of entities may have their own data structure, but conceptually they are equivalent in most other ways. |
10 | * revision: A version of the store. One entity may have multiple revisions in a store, representing (for instance) the local state and the synchronized state of the entity. | 10 | * revision: A version of the store. One entity may have multiple revisions in a store, representing (for instance) the local state and the synchronized state of the entity. |
11 | * source: The canonical data set, which may be a remote IMAP server, a local iCal file, a local maildir, etc. | 11 | * source: The canonical data set, which may be a remote IMAP server, a local iCal file, a local maildir, etc. |
@@ -20,6 +20,6 @@ It is recommended to familiarize yourself with the terms before going further in | |||
20 | * command queue: A queue of commands kept by the synchronizer to ensure durability and, when necessary, replayability | 20 | * command queue: A queue of commands kept by the synchronizer to ensure durability and, when necessary, replayability |
21 | * notification: A message sent from a synchronizer to inform the client of a change in the store | 21 | * notification: A message sent from a synchronizer to inform the client of a change in the store |
22 | * domain object: An application domain object, i.e. an event. | 22 | * domain object: An application domain object, i.e. an event. |
23 | * domain type: The type of a domain object. i.e. Akonadi2::ApplicationDomain::Event | 23 | * domain type: The type of a domain object. i.e. Sink::ApplicationDomain::Event |
24 | * buffer: The buffers used by the resources to persist data in the datastore. | 24 | * buffer: The buffers used by the resources to persist data in the datastore. |
25 | * buffer type: The individual buffer types as specified by the resource. These are internal types that don't necessarily have a 1:1 mapping to the domain types, although that is the default case that the default implementations expect. | 25 | * buffer type: The individual buffer types as specified by the resource. These are internal types that don't necessarily have a 1:1 mapping to the domain types, although that is the default case that the default implementations expect. |