From e5d5c8373c29dc272f2ee2fb52187213edb48b94 Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Mon, 11 Dec 2017 13:38:50 +0100 Subject: [PATCH] Update doc, add FAQ. Closes #97 --- doc/3.faq.md | 17 +++++++++++++++++ doc/index.rst | 1 + 2 files changed, 18 insertions(+) create mode 100644 doc/3.faq.md diff --git a/doc/3.faq.md b/doc/3.faq.md new file mode 100644 index 0000000..d29963a --- /dev/null +++ b/doc/3.faq.md @@ -0,0 +1,17 @@ +FAQ +=== + +## What happens when duplicates are detected across different backends? + +There is a default precedence defined for each backend. This should be defined +so that the backend with highest precedence is the backend that should contain +the most precise information usually. + +When deduplicating, the post from the backend with the highest precedence is +kept and missing info is taken from the duplicate posts (precedence is used so +that in case of conflicts in a field, the data from the backend with highest +precedence is used). This post contains as much data as possible, and includes +references to all the other "duplicate" posts. These latter duplicate posts +are then simply marked as such and never shown anymore. + +All origins are kept in a `urls` field in the remaining post. diff --git a/doc/index.rst b/doc/index.rst index 4a52d31..d2a5026 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,6 +13,7 @@ Welcome to Flatisfy's documentation! 0.getting_started.md 1.production.md 2.docker.md + 3.faq.md modules.rst