From 87c27e132e60dc9d44f5714c227c8434a89ecbff Mon Sep 17 00:00:00 2001
From: Alessandro CERIONI <acerioni@grandlyon.com>
Date: Fri, 6 Mar 2020 11:53:49 +0100
Subject: [PATCH] Update editorial-content.md

---
 docs/components/indexers/editorial-content.md | 30 +++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/docs/components/indexers/editorial-content.md b/docs/components/indexers/editorial-content.md
index e69de29..e9f31c3 100644
--- a/docs/components/indexers/editorial-content.md
+++ b/docs/components/indexers/editorial-content.md
@@ -0,0 +1,30 @@
+# Editorial Content Indexer
+
+## Features
+
+This indexer provides methods to index in Elasticsearch the editorial content (pages, posts) that is produced with the Ghost CMS. It relies on Ghost's "Custom Integrations" feature, cf. https://ghost.org/docs/api/v2/webhooks/.
+
+It provides two indexation strategies:
+* full
+* incremental (adding/updating/deleting pages or posts)
+
+
+As an additional feature, it includes in the Elasticsearch index the *relations* of a given post or page to other posts, pages and datasets.
+
+
+## Requirements
+
+* A working Ghost installation
+* An Admin API Key (provided by Ghost, when configuring a custom integration)
+* A working Elasticsearch installation
+
+
+## Implementation
+
+The indexer is developed in Python, using the Flask framework to expose an API. The authentified access to the Ghost API requires a JWT which is generated with the [JSON Web Token JavaScript module](https://www.npmjs.com/package/jsonwebtoken)
+
+## TODO
+* see whether the JWT could be generated in Python
+* understand why a `get_content` is performed despite the content being pushed when the event is fired
+* implement the support for multiple languages (EN, FR, ...)
+* exploit logs
\ No newline at end of file
-- 
GitLab