summaryrefslogtreecommitdiffstats
path: root/docs/extending.md
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2016-01-20 19:07:38 +0100
committerChristian Mollekopf <chrigi_1@fastmail.fm>2016-01-20 19:07:38 +0100
commit944d1f728cb1612daa51aa2c550c0bcb67166852 (patch)
treef0a52d10dfbb855da0b1db17f820b4a73bfa8e40 /docs/extending.md
parentbdb01c2c068df326f5a8328ed1492ab1bea388c5 (diff)
downloadsink-944d1f728cb1612daa51aa2c550c0bcb67166852.tar.gz
sink-944d1f728cb1612daa51aa2c550c0bcb67166852.zip
Use Sink in docs.
Diffstat (limited to 'docs/extending.md')
-rw-r--r--docs/extending.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/extending.md b/docs/extending.md
new file mode 100644
index 0000000..fe38e87
--- /dev/null
+++ b/docs/extending.md
@@ -0,0 +1,11 @@
1## Steps to add support for new types
2* Add new type to applicationdomaintypes.h and implement `getTypenName()`
3* Implement `TypeImplementation<>` for updating indexes etc.
4* Add a type.fbs default schema for the type
5
6## Steps for adding support for a type to a resource
7* Add a TypeAdaptorFactory, which can either register resource specific mappers, or stick to what the default implementation in TypeImplementation provides
8* Add a TypeFacade that injects the TypeAdaptorFactory in the GenericFacade
9* Register the facade in the resource
10* Add synchronization code that creates the relevant objects
11