From 228f31e254383cd4cdc888d9c2277e03fdaf899a Mon Sep 17 00:00:00 2001
From: Bernhard Posselt <dev@bernhard-posselt.com>
Date: Sat, 30 Apr 2016 15:51:22 +0200
Subject: More dev docs

---
 docs/developer/Article-Enhancers.md      |  27 ++
 docs/developer/External-Api.md           | 734 +++++++++++++++++++++++++++++++
 docs/developer/Plugins.md                | 202 +++++++++
 docs/developer/README.md                 |   6 +
 docs/developer/external-api-v2/README.md | 734 -------------------------------
 docs/developer/plugins/README.md         | 202 ---------
 6 files changed, 969 insertions(+), 936 deletions(-)
 create mode 100644 docs/developer/Article-Enhancers.md
 create mode 100644 docs/developer/External-Api.md
 create mode 100644 docs/developer/Plugins.md
 create mode 100644 docs/developer/README.md
 delete mode 100644 docs/developer/external-api-v2/README.md
 delete mode 100644 docs/developer/plugins/README.md

(limited to 'docs')

diff --git a/docs/developer/Article-Enhancers.md b/docs/developer/Article-Enhancers.md
new file mode 100644
index 000000000..7d2613427
--- /dev/null
+++ b/docs/developer/Article-Enhancers.md
@@ -0,0 +1,27 @@
+# Article Enhancers
+You can enhance the feed download and rendering process in the following ways:
+
+* Adding custom full text rules
+* Adding custom CSS
+
+In any case, please consider **contributing your changes back** to either [picoFeed](https://github.com/fguillot/picoFeed) or [News](https://github.com/owncloud/news/blob/master/css/custom.css)
+
+## Custom Full Text Feed Rules
+The News app uses [picoFeed](https://github.com/fguillot/picoFeed) for parsing RSS and Atom feeds. It also provides a web scraper which can be extended with custom rules. If you want to extend these rules or add your own ones, follow [the picoFeed documentation](https://github.com/fguillot/picoFeed/blob/master/docs/grabber.markdown#how-to-write-a-grabber-rules-file)
+
+## Custom CSS
+Sometimes you want to add additional CSS for a feed to improve the rendering. This can very easily be done by adding a CSS class to **css/custom.css** following the following naming convention:
+
+* Take the URL from the \<link> attribute (e.g.: \<link>https://www.google.de/path?my=query \</link>)
+* Extract the Domain from the URL (e.g.: www.google.de)
+* Strip the leading **www.** (e.g.: google.de)
+* Replace all . with - (e.g.: google-de)
+* Prepend **custom-** (e.g.: custom-google-de)
+
+Each class rule should be prefixed with **#app-content** and should only affect the article body. An example rule would be:
+
+```css
+#app-content .custom-google-de .body {
+    /* Custom CSS rules here */
+}
+```
\ No newline at end of file
diff --git a/docs/developer/External-Api.md b/docs/developer/External-Api.md
new file mode 100644
index 000000000..8d20bd794
--- /dev/null
+++ b/docs/developer/External-Api.md
@@ -0,0 +1,734 @@
+# External API v2 (Draft)
+
+The **News app** offers a RESTful API which can be used to sync folders, feeds and items. The API also supports [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) which means that you can access the API from your browser using JavaScript.
+
+In addition, an updater API is exposed which enables API users to run feed updates in parallel using a REST API or ownCloud console API.
+
+## Conventions
+This document uses the following conventions:
+
+* Object aliases as comments
+* Error objects are omitted
+
+### Object Aliases As Comments
+
+In order to only specify the JSON objects once, comments are used to alias them.
+
+There are two types of aliases:
+* Objects
+* Object arrays
+
+**Objects**:
+```js
+{
+    "data": {
+        "folder": { /* folder object */ },
+    }
+}
+```
+
+means that the folder attributes will be listed inside the **folder** object
+
+**Object arrays**:
+```js
+{
+    "data": {
+        "folders": [ /* array of folder objects */ ],
+    }
+}
+```
+
+means that folder objects will be listed inside the **folders** array.
+
+### Error Objects Are Omitted
+
+This means that the error object will not be explicitely shown in the examples. All HTTP 400 response status codes contain an error object:
+
+```json
+{
+    "data": { },
+    "error": {
+        "code": 1,
+        "message": "error message"
+    }
+}
+```
+
+## API Stability Contract
+
+The API level will **change** if the following occurs:
+
+* a required HTTP request header is added
+* a required request parameter is added
+* a field of a response object is removed
+* a field of a response object is changed to a different datatype
+* an HTTP response header is removed
+* an HTTP response header is changed to a different datatype
+* the meaning of an API call changes (e.g. /sync will not sync any more but show a sync timestamp)
+
+The API level will **not change** if:
+
+* a new HTTP response header is added
+* an optional new HTTP request header is added
+* a new response parameter is added (e.g. each item gets a new field "something": 1)
+* The order of the JSON attributes is changed on any level (e.g. "id":3 is not the first field anymore, but the last)
+
+You have to design your app with these things in mind!:
+
+* **Don't depend on the order** of object attributes. In JSON it does not matter where the object attribute is since you access the value by name, not by index
+* **Don't limit your app to the currently available attributes**. New ones might be added. If you don't handle them, ignore them
+* **Use a library to compare versions**, ideally one that uses semantic versioning
+
+## Authentication
+Because REST is stateless you have to re-send user and password each time you access the API. Therefore running ownCloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**.
+
+The base URL for all calls is:
+
+    https://yourowncloud.com/index.php/apps/news/api/v2
+
+All defined routes in the Specification are appended to this url. To access the sync for instance you'd use the following url:
+
+    https://yourowncloud.com/index.php/apps/news/api/v2/sync
+
+Credentials are passed as an HTTP header using [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side):
+
+    Authorization: Basic $CREDENTIALS
+
+where $CREDENTIALS is:
+
+    base64(USER:PASSWORD)
+
+This authentication/authorization method will be the recommended default until core provides an easy way to do OAuth
+
+## Request Format
+The required request headers are:
+* **Accept**: application/json
+
+Any request method except GET:
+* **Content-Type**: application/json; charset=utf-8
+
+Any route that allows caching:
+* **If-None-Match**: an Etag, e.g. 6d82cbb050ddc7fa9cbb659014546e59. If no previous Etag is known, this header should be omitted
+
+The request body is either passed in the URL in case of a **GET** request (e.g.: **?foo=bar&index=0**) or as JSON, e.g.:
+
+```json
+{
+    "foo": "bar",
+    "index": 0
+}
+```
+
+## Response Format
+The status codes are not always provided by the News app itself, but might also be returned because of ownCloud internal errors.
+
+The following status codes can always be returned by ownCloud:
+* **401**: The provided credentials to log into ownCloud are invalid.
+* **403**: The user is not allowed to access the route. This can happen if for instance of only users in the admin group can access the route and the user is not in it.
+* **404**: The route can not be found or the resource does not exist. Can also happen if for instance you are trying to delete a folder which does not exist.
+* **5xx**: An internal server error occurred. This can happen if the server is in maintenance mode or because of other reasons.
+
+The following status codes are returned by News:
+* **200**: Everything went fine
+* **304**: In case the resource was not modified, contains no response body. This means that you can ignore the request since everything is up to date.
+* **400**: There was an app related error, check the **error** object if specified
+* **409**: Conflict error which means that the resource exists already. Can be returned when updating (**PATCH**) or creating (**POST**) a resource, e.g. a folder
+
+The response headers are:
+* **Content-Type**: application/json; charset=utf-8
+* **Etag**: A string containing a cache header of maximum length 64, e.g. 6d82cbb050ddc7fa9cbb659014546e59
+
+The response body is a JSON structure that looks like this:
+
+```json
+{
+    "data": { },
+    "error": {
+        "code": 1,
+        "message": "error message"
+    }
+}
+```
+
+* **data**: Contains the payload
+* **error**: Only present when an HTTP 400 is returned to help distinguishing between error causes
+  * **code**: A unique error code
+  * **message**: A translated error message. The user's configured locale is used.
+
+In case of an **4xx** or **5xx** error the request was not successful and has to be retried. For instance marking items as read locally and syncing should send the same request again the next time the user syncs in case an error occured.
+
+## Security Guidelines
+Read the following notes carefully to prevent being subject to security exploits:
+* All string fields in a JSON response unless explicitly noted otherwise are provided in without sanitation. This means that if you do not escape it properly before rendering you will be vulnerable to [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_%28XSS%29) attacks
+* Basic Auth headers can easily be decrypted by anyone since base64 is an encoding, not an encryption. Therefore only send them if you are accessing an HTTPS website or display an easy to understand warning if the user chooses HTTP
+* When creating a feed you can choose to add basic auth authentication credentials. These must be stored in clear text so anyone with access to your database (however they might have achieved it, think of Sql injection) can read them and use them to access the website. You should warn the user about this.
+
+## Syncing
+All routes are given relative to the base API url, e.g.: **/sync** becomes  **https://yourowncloud.com/index.php/apps/news/api/v2/sync**
+
+There are two usecases for syncing:
+* **Initial sync**: the user does not have any data at all
+* **Syncing local and remote changes**: the user has synced at least once and wants to submit and receive changes
+
+### Initial Sync
+The intial sync happens when a user adds an ownCloud account in your app. In that case you want to download all folders, feeds and unread/starred items. To do this, make the following request:
+
+* **Method**: GET
+* **Route**: /sync
+* **Authentication**: [required](#authentication)
+* **HTTP headers**:
+  * **Accept: "application/json"**
+
+This will return the following status codes:
+* **200**: Success
+
+and the following HTTP headers:
+* **Content-Type**: application/json; charset=utf-8
+* **Etag**: A string containing a cache header, maximum size 64 ASCII characters, e.g. 6d82cbb050ddc7fa9cbb659014546e59
+
+and the following request body:
+```js
+{
+    "data": {
+        "folders": [ /* array of folder objects */ ],
+        "feeds": [ /* array of feed objects */ ],
+        "items": [ /* array of item objects */ ]
+    }
+}
+```
+
+**Hint**: Each object is explained in more detail in a separate section:
+* [Folders](#folders)
+* [Feeds](#feeds)
+* [Items](#items)
+
+
+### Sync Local And Remote Changes
+After the initial sync the app has all folders, feeds and items. Now you want to push changes and retrieve updates from the server. To do this, make the following request:
+
+* **Method**: POST
+* **Route**: /sync
+* **Authentication**: [required](#authentication)
+* **HTTP headers**:
+  * **Content-Type: "application/json; charset=utf-8"**
+  * **Accept: "application/json"**
+  * **If-None-Match: "6d82cbb050ddc7fa9cbb659014546e59"** (Etag from the previous request to the /sync route)
+
+with the following request body:
+
+```js
+{
+    "items": [{
+            // read and starred
+            "id": 5,
+            "isStarred": false,
+            "isRead": true,
+            "fingerprint": "08ffbcf94bd95a1faa6e9e799cc29054"
+        }, {
+            // only read
+            "id": 6,
+            "isRead": true,
+            "fingerprint": "09ffbcf94bd95a1faa6e9e799cc29054"
+        }, {
+            // only starred
+            "id": 7,
+            "isStarred": false,
+            "fingerprint": "18ffbcf94bd95a1faa6e9e799cc29054"
+    }, /* etc */]
+}
+```
+
+If no items have been read or starred, simply leave the **items** array empty, e.g.:
+
+```js
+{
+    "items": []
+}
+```
+
+The response matches the **GET** call, except there can be two different types of item objects:
+* **[Full](#full)**: Contains all attributes
+* **[Reduced](#reduced)**: Contains only **id**, **isRead** and **isStarred**
+
+The deciding factor whether a full or reduced item object is being returned depends on the fingerprint in the request: If the fingerprint matches the record in the database a reduced item object is being returned, otherwise a full object is used. Both can occur in the same items array at the same time.
+
+The idea behind this special handling is that if the fingerprint matches the record in the database, the actual item content did not change. Therefore it is enough to know the item status. This greatly reduces the amount sent over the Net which is especially important for mobile apps.
+
+## Folders
+Folders are represented using the following data structure:
+```json
+{
+    "id": 3,
+    "name": "funny stuff"
+}
+```
+
+The attributes mean the following:
+* **id**: 64bit Integer, id
+* **name**: Abitrary long text, folder's name
+
+### Deleting A Folder
+To delete a folder, use the following request:
+* **Method**: DELETE
+* **Route**: /folders/{id}
+* **Route Parameters**:
+  * **{id}**: folder's id
+* **Authentication**: [required](#authentication)
+
+The following response is being returned:
+
+Status codes:
+* **200**: Folder was deleted successfully
+* **404**: Folder does not exist
+
+In case of an HTTP 200, the deleted folder is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "folder": { /* folder object */ }
+    }
+}
+```
+### Creating A Folder
+To create a folder, use the following request:
+* **Method**: POST
+* **Route**: /folders
+* **Authentication**: [required](#authentication)
+
+with the following request body:
+```json
+{
+    "name": "Folder name"
+}
+```
+
+The following response is being returned:
+
+Status codes:
+* **200**: Folder was created successfully
+* **400**: Folder creation error, check the error object:
+  * **code**: 1: folder name is empty
+* **409**: Folder with given name exists already
+
+In case of an HTTP 200 or 409, the created or already existing folder is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "folder": { /* folder object */ }
+    }
+}
+```
+
+### Changing A Folder
+The following attributes can be changed on the folder:
+* **name**
+
+To change any number of attributes on a folder, use the following request and provide as much attributes that can be changed as you want:
+* **Method**: PATCH
+* **Route**: /folders/{id}
+* **Route Parameters**:
+  * **{id}**: folder's id
+* **Authentication**: [required](#authentication)
+
+with the following request body:
+```json
+{
+    "name": "New folder name"
+}
+```
+
+* **name**: Abitrary long text, the folder's name
+
+The following response is being returned:
+
+Status codes:
+* **200**: Folder was created successfully
+* **400**: Folder creation error, check the error object:
+  * **code**: 1: folder name is empty
+* **409**: Folder with given name exists already
+* Other ownCloud errors, see [Response Format](#response-format)
+
+In case of an HTTP 200 or 409, the changed or already existing folder is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "folder": { /* folder object */ }
+    }
+}
+```
+
+
+## Feeds
+Feeds are represented using the following data structure:
+
+```json
+{
+    "id": 4,
+    "name": "The Oatmeal - Comics, Quizzes, & Stories",
+    "faviconLink": "http://theoatmeal.com/favicon.ico",
+    "folderId": 3,
+    "ordering": 0,
+    "fullTextEnabled": false,
+    "updateMode": 0,
+    "isPinned": true,
+    "error": {
+        "code": 1,
+        "message": ""
+    }
+}
+```
+
+The attributes mean the following:
+* **id**: 64bit Integer, id
+* **name**: Abitrary long text, feed's name
+* **faviconLink**: Abitrary long text, feed's favicon location, **null** if not found
+* **folderId**: 64bit Integer, the feed's folder or **0** in case no folder is specified
+* **ordering**: 64bit Integer, overrides the feed's default ordering:
+  * **0**: Default
+  * **1**: Oldest on top
+  * **2**: Newest on top
+* **updateMode**: 64bit Integer, describing how item updates are handled:
+  * **0**: No special behavior
+  * **1**: If an item is updated, mark it unread
+* **isPinned**: Boolean, Used to list certain feeds before others. Feeds are first ordered by their **isPinned** value (true before false) and then by their name in alphabetical order
+* **error**: error object, only present if an error occurred:
+  * **code**: The error code:
+    * **1**: Error occured during feed update
+  * **message**: Translated error message depending on the user's configured server locale
+
+
+### Deleting A Feed
+To delete a feed, use the following request:
+* **Method**: DELETE
+* **Route**: /feeds/{id}
+* **Route Parameters**:
+  * **{id}**: feed's id
+* **Authentication**: [required](#authentication)
+
+
+The following response is being returned:
+
+Status codes:
+* **200**: Feed was deleted successfully
+* **404**: Feed with given id was not found, no error object
+* Other ownCloud errors, see [Response Format](#response-format)
+
+
+In case of an HTTP 200, the deleted feed is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "feed": { /* feed object */ }
+        }
+    }
+}
+```
+
+### Creating A feed
+To create a feed, use the following request:
+* **Method**: POST
+* **Route**: /feeds
+* **Authentication**: [required](#authentication)
+
+
+with the following request body:
+```json
+{
+    "url": "https://feed.url.com",
+    "name": "Folder name",
+    "ordering": 0,
+    "isPinned": true,
+    "fullTextEnabled": false,
+    "basicAuthUser": "user",
+    "basicAuthPassword": "password"
+}
+```
+* **url**: Abitrary long text, the url needs to have the full schema e.g. https://the-url.com. In case the user omits the schema, prepending **https** is recommended
+* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
+* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
+* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
+* **ordering (optional)**: See [Feeds](#feeds)
+* **isPinned (optional)**: See [Feeds](#feeds)
+* **fullTextEnabled (optional)**: See [Feeds](#feeds)
+
+
+The following response is being returned:
+
+Status codes:
+* **200**: Feed was created successfully
+* **400**: Feed creation error, check the **error** object:
+  * **code**: 1: url is empty
+  * **code**: 2: malformed xml
+  * **code**: 3: no feed found for url (e.g. website does not have an RSS or Atom feed or direct link to feed is no feed)
+  * **code**: 4: feed format not supported (e.g. too old RSS version)
+  * **code**: 5: ssl issues (e.g. SSL certificate is invalid or php has issues accessing certificates on your server)
+  * **code**: 6: url can not be found or accessed
+  * **code**: 7: maximum redirects reached
+  * **code**: 8: maximum size reached
+  * **code**: 9: request timed out
+  * **code**: 10: invalid or missing http basic auth headers
+  * **code**: 11: not allowed to access the feed (difference here is that the user can be authenticated but not allowed to access the feed)
+
+In case of an HTTP 200, the created feed is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "feed": { /* feed object */ }
+    }
+}
+```
+
+
+### Changing A Feed
+To change a feed, use the following request:
+* **Method**: PATCH
+* **Route**: /feeds/{id}
+* **Route Parameters**:
+  * **{id}**: feed's id
+* **Authentication**: [required](#authentication)
+
+
+with the following request body:
+```json
+{
+    "url": "https://feed.url.com",
+    "name": "Folder name",
+    "ordering": 0,
+    "isPinned": true,
+    "fullTextEnabled": false,
+    "basicAuthUser": "user",
+    "basicAuthPassword": "password"
+}
+```
+
+All parameters are optional
+
+* **url (optional)**: Abitrary long text, the url which was entered by the user with the full schema
+* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
+* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
+* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
+* **ordering (optional)**: See [feeds](#Feeds)
+* **isPinned (optional)**: See [feeds](#Feeds)
+* **fullTextEnabled (optional)**: See [feeds](#Feeds)
+
+The following response is being returned:
+
+Status codes:
+* **200**: Feed was changed successfully
+* **400**: Feed creation error, check the error object:
+  * **code**: 1: url is empty
+  * **code**: 2: malformed xml
+  * **code**: 3: no feed found for url (e.g. website does not have an RSS or Atom feed or direct link to feed is no feed)
+  * **code**: 4: feed format not supported (e.g. too old RSS version)
+  * **code**: 5: ssl issues (e.g. SSL certificate is invalid or php has issues accessing certificates on your server)
+  * **code**: 6: url can not be found or accessed
+  * **code**: 7: maximum redirects reached
+  * **code**: 8: maximum size reached
+  * **code**: 9: request timed out
+  * **code**: 10: invalid or missing http basic auth headers
+  * **code**: 11: not allowed to access the feed (difference here is that the user can be authenticated but not allowed to access the feed)
+* Other ownCloud errors, see [Response Format](#response-format)
+
+In case of an HTTP 200, the changed feed is returned in full in the response, e.g.:
+
+```js
+{
+    "data": {
+        "feed": { /* feed object */ }
+    }
+}
+```
+
+## Items
+
+Items can occur in two different formats:
+
+* Full
+* Reduced
+
+The attributes mean the following:
+* **id**: 64bit Integer, id
+* **url**: Abitrary long text, location of the online resource
+* **title**: Abitrary long text, item's title
+* **author**: Abitrary long text, name of the author/authors
+* **publishedAt**: String representing an ISO 8601 DateTime object, when the item was published
+* **updatedAt**: String representing an ISO 8601 DateTime object, when the item was updated
+* **enclosures**: A list of enclosure objects,
+  * **mime**: Mimetype
+  * **url**: Abitrary long text, location of the enclosure
+* **body**: Abitrary long text, **sanitized (meaning: does not have to be escape)**, contains the item's content
+* **feedId**: 64bit Integer, the item's feed it belongs to
+* **isUnread**: Boolean, true if unread, false if read
+* **isStarred**: Boolean, true if starred, false if not starred
+* **fingerprint**: 64 ASCII characters, hash that is used to determine if an item is the same as an other one. The following behavior should be implemented:
+  * Items in a stream (e.g. All items, folders, feeds) should be filtered so that no item with the same fingerprint is present.
+  * When marking an item read, all items with the same fingerprint should also be marked as read.
+
+### Full
+A full item contains the full content:
+```json
+{
+    "id": 5,
+    "url": "http://grulja.wordpress.com/2013/04/29/plasma-nm-after-the-solid-sprint/",
+    "title": "Plasma-nm after the solid sprint",
+    "author": "Jan Grulich (grulja)",
+    "publishedAt": "2005-08-15T15:52:01+0000",
+    "updatedAt": "2005-08-15T15:52:01+0000",
+    "enclosures": [{
+        "mime": "video/webm",
+        "url": "http://video.webmfiles.org/elephants-dream.webm"
+    }],
+    "body": "<p>At first I have to say...</p>",
+    "feedId": 4,
+    "isUnread": true,
+    "isStarred": true,
+    "fingerprint": "08ffbcf94bd95a1faa6e9e799cc29054"
+}
+```
+
+### Reduced
+A reduced item only contains the item status:
+```json
+{
+    "id": 5,
+    "isUnread": true,
+    "isStarred": true
+}
+```
+
+## Updater
+Instead of using the built in, slow cron updater you can use the parallel update API to update feeds. The API can be accessed through REST or ownCloud console API.
+
+The API should be used in the following way:
+
+* Clean up before the update
+* Get all feeds and user ids
+* For each feed and user id, run the update
+* Clean up after the update
+
+The reference [implementation in Python](https://github.com/owncloud/news-updater) should give you a good idea how to design your own updater.
+
+If the REST API is used, Authorization is required via Basic Auth and the user needs to be in the admin group.
+If the ownCloud console API is used, no authorization is required.
+
+### Clean Up Before Update
+This is used to clean up the database. It deletes folders and feeds that are marked for deletion.
+
+**Console API**:
+
+    php -f /path/to/owncloud/occ news:updater:before-update
+
+**REST API**:
+
+* **Method**: GET
+* **Route**: /updater/before-update
+* **Authentication**: [admin](#authentication)
+
+### Get All Feeds And User Ids
+This call returns pairs of feed ids and user ids.
+
+**Console API**:
+
+    php -f /path/to/owncloud/occ news:updater:all-feeds
+
+**REST API**:
+
+* **Method**: GET
+* **Route**: /updater/all-feeds
+* **Authentication**: [admin](#authentication)
+
+
+Both APIs will return the following response body or terminal output:
+
+```js
+{
+    "data": {
+        "updater": [{
+          "feedId": 3,
+          "userId": "john"
+        }, /* etc */]
+    }
+}
+```
+
+### Update A User's Feed
+After all feed ids and user ids are known, feeds can be updated in parallel.
+
+**Console API**:
+* **Positional Parameters**:
+  * **{feedId}**: the feed's id
+  * **{userId}**: the user's id
+
+
+    php -f /path/to/owncloud/occ news:updater:update-feed {feedId} {userId}
+
+**REST API**:
+
+* **Method**: GET
+* **Route**: /updater/update-feed?feedId={feedId}&userId={userId}
+* **Route Parameters**:
+  * **{feedId}**: the feed's id
+  * **{userId}**: the user's id
+* **Authentication**: [admin](#authentication)
+
+
+### Clean Up After Update
+This is used to clean up the database. It removes old read articles which are not starred.
+
+**Console API**:
+
+    php -f /path/to/owncloud/occ news:updater:after-update
+
+**REST API**:
+
+* **Method**: GET
+* **Route**: /updater/after-update
+* **Authentication**: [admin](#authentication)
+
+## Meta Data
+The retrieve meta data about the app, use the following request:
+
+* **Method**: GET
+* **Route**: /
+* **Authentication**: [required](#authentication)
+
+
+The following response is being returned:
+
+Status codes:
+* **200**: Meta data accessed successfully
+
+In case of an HTTP 200, the the following response is returned:
+
+```json
+{
+    "version": "9.0.0",
+    "issues": {
+        "improperlyConfiguredCron": false
+    },
+    "user": {
+        "userId": "john",
+        "displayName": "John Doe",
+        "avatar": {
+            "data": "asdiufadfasdfjlkjlkjljdfdf",
+            "mime": "image/jpeg"
+        }
+    }
+}
+```
+
+The attributes mean the following:
+* **version**: Abitrary long text, News app version
+* **issues**: An object containing a dictionary of issues which need to be displayed to the user:
+  * **improperlyConfiguredCron**: Boolean, if true this means that no feed updates are run on the server because the updater is misconfigured
+* **user**: user information:
+  * **userId**: Abitrary long text, the login name
+  * **displayName**: Abitrary long text, the full name like it's displayed in the web interface
+  * **avatar**: an avatar object, null if none is set
+    * **data**: Abitrary long text, the user's image encoded as base64
+    * **mime**: Abitrary long text, avatar mimetype
diff --git a/docs/developer/Plugins.md b/docs/developer/Plugins.md
new file mode 100644
index 000000000..22d29efa7
--- /dev/null
+++ b/docs/developer/Plugins.md
@@ -0,0 +1,202 @@
+# How To Write Plugins
+
+Plugins were created to keep the app maintainable while still making it possible to easily implement additional functionality.
+
+There are essentially three different use cases for plugins:
+* Creating or extending server-side functionality, e.g. creating additional REST API endpoints
+* Offering article actions such as share via Twitter or E-Mail
+* Dropping in additional CSS or JavaScript
+
+## The Basics
+Whatever plugin you want to create, you first need to create a basic structure. A plugin is basically  just an app so you can take advantage of the full [ownCloud app API](https://doc.owncloud.org/server/9.0/developer_manual/app/index.html). If you want you can [take a look at the developer docs](https://doc.owncloud.org/server/9.0/developer_manual/app/index.html) or [dig into the tutorial](http://doc.owncloud.org/server/9.0/developer_manual/app/appframework/tutorial.html).
+
+However if you just want to start slow, the full process is described below.
+
+First create the following directories and files:
+
+* **newsplugin/**
+  * **appinfo/**
+     * **app.php**
+     * **info.xml**
+
+The first folder name affects the name and namespace of your plugin and only one app can exist using the same name. Choose wisely.
+
+First let's add some meta data about our app. Open the **newsplugin/appinfo/info.xml** and add the following contents:
+
+```xml
+<?xml version="1.0"?>
+<info>
+    <id>newsplugin</id>
+    <name>Example News Plugin</name>
+    <description>This plugin allows you to share articles via Twitter</description>
+    <licence>AGPL</licence>
+    <author>Your Name Here</author>
+    <version>0.0.1</version>
+    <dependencies>
+        <owncloud min-version="9.0"/>
+        <php min-version="5.6"/>
+    </dependencies>
+</info>
+```
+
+**Note**: You must license your app under the [AGPL 3 or later](http://www.gnu.org/licenses/agpl-3.0.en.html) to comply with the News app's license. Don't forget to add the license as plain text file if you want to distribute your app!
+
+Then we want to make sure that our code is only run if the News app is enabled. To do that put the following PHP code into the **newsplugin/appinfo/app.php** file:
+
+```php
+<?php
+namespace OCA\NewsPlugin\AppInfo;
+use OCP\App;
+
+if (App::isEnabled('news')) {
+    // your code here
+}
+```
+
+If your plugin integrates with another ownCloud app, make sure to also require it be installed. If you depend on the bookmarks app for instance use:
+
+```php
+<?php
+namespace OCA\MyNewsPlugin\AppInfo;
+use OCP\App;
+
+if (App::isEnabled('news') && App::isEnabled('bookmarks')) {
+    // your code here
+}
+```
+
+Now you are ready to enable the app. Head over to the apps section and choose the **Not enabled** section. Your app should be listed under the name **Example News Plugin** (or whatever name you set in the **info.xml**).
+
+With the basics set up, you can now choose how to progress further. In our case we just want to add some additional CSS and JavaScript, so we are going to create a client-side plugin.
+
+## Client-Side Plugin
+
+A client-side plugin is adding additional JavaScript and/or CSS to the News app. Remember the **app.php**? Open it and place the following contents inside:
+
+```php
+<?php
+namespace OCA\MyNewsPlugin\AppInfo;
+use OCP\App;
+
+if (App::isEnabled('news') && class_exists('OCA\News\Plugin\Client\Plugin')) {
+    \OCA\News\Plugin\Client\Plugin::registerScript('newsplugin', 'script');
+    \OCA\News\Plugin\Client\Plugin::registerStyle('newsplugin', 'style');
+}
+```
+
+This will tell the News app to load load the following files after its own JavaScript and CSS files have been included:
+
+* **newsplugin/js/script.js**
+* **newspluing/css/style.css**
+
+### Adding Basic JavaScript Functionality
+You can basically add any JavaScript you want. If you want to add an additional article action, this is a bit more complicated because it's hard to hook into Angular from the outside. Therefore the News app provides an API which makes creating additional article actions a breeze.
+
+A basic article action looks like this:
+
+```js
+News.addArticleAction(function($actionsElement, article) {
+    // your code here
+});
+```
+
+The **addArticleAction** method expects a function with the following parameters:
+* **$actionsElement**: The DOM element wrapped in jQuery where your plugin should be appended to
+* **article**: The current article's data (readonly!). The article object has the following properties:
+    * **id**: the article id in the News database
+    * **url**: the article url it points to
+    * **title**: the article title
+    * **author**: the article author
+    * **pubDate**: the article published date, a unix timestamp
+    * **body**: the html content
+    * **enclosureMime**: if an enclosure is added, this is the mime type
+    * **enclosureLink**: this is the source of the enclosure
+    * **feedId**: the feed id it belongs to
+    * **unread**: if the article is unread (bool)
+    * **starred**: if the article is starred (bool)
+    * **lastModified**: the last modified date
+
+With that in mind, let's add the Twitter button. Open the JavaScript file at **newsplugin/js/script.js** and add the following contents:
+
+```js
+News.addArticleAction(function($actionsElement, article) {
+    var $li = $('<li>')
+        .addClass('article-plugin-twitter');
+    var $button = $('<button>')
+        .attr('title', t('newsplugin', 'Share on Twitter'));
+    var text = 'Read this: ' + article.url;
+    var url = 'https://twitter.com/intent/tweet?text=' + encodeURIComponent(text);
+
+    $button.click(function (event) {
+        window.open(url);
+        event.stopPropagation();  // prevent expanding in compact mode
+    });
+
+    $li.append($button);
+    $actionsElement.append($li);
+});
+```
+
+Great! Now the only thing left is to add some styles.
+
+### Adding Styles
+
+Now let's add some styles to our app. We want to style the button to look like a Twitter icon, so simply download an icon (e.g. [from Wikipedia](https://commons.wikimedia.org/wiki/File:Twitter_icon.png)) and place it at **newsplugin/img/twitter.png**.
+
+Then open the **newspluing/css/style.css** file and add the following CSS:
+
+```css
+.article-plugin-twitter button {
+    background-image: url('../img/twitter.png');
+}
+```
+
+Reload the News app and click the three dots menu, sit back and enjoy :)
+
+## Server-Side Plugin
+A Server-Side plugin is a plugin that uses the same infrastructure as the News app for its own purposes. An example would be a plugin that makes the starred entries of a user available via an interface or a bookmark app that that also shows starred articles as bookmarks.
+
+It's very easy to interface with the News app. Because all Classes are registered in the **news/app/application.php** it takes almost no effort to use the same infrastructure.
+
+**Note**: Keep in mind that these classes are essentially private which means they might break if the News app changes. There is no real public API so use at your own risk ;)
+
+Since you dont want to extend the app but use its resources, its advised that you dont inherit from the **Application** class but rather include it in your own container in **newsplugin/appinfo/application.php**:
+
+```php
+<?php
+namespace OCA\NewsPlugin\AppInfo;
+
+use OCP\AppFramework\App;
+use OCA\News\AppInfo\Application as News;
+
+class Application extends App {
+
+    public function __construct (array $urlParams=[]) {
+        parent::__construct('newsplugin', $urlParams);
+
+        $container = $this->getContainer();
+
+        $container->registerService('NewsContainer', function($c) {
+            $app = new News();
+            return $app->getContainer();
+        });
+
+        $container->registerService(OCA\News\Service\FeedService::class, function($c) {
+            // use the feed service from the news app, you can use all
+            // defined classes but its recommended that you stick to the
+            // mapper and service classes since they are less likely to change
+            return $c->query('NewsContainer')->query(OCA\News\Service\FeedService::class);
+        });
+    }
+
+}
+```
+
+Using automatic container assembly you can then use it from your code by simply adding the type to your constructors.
+
+
+### Examples
+Client-side plugins:
+* [Mail Share](https://github.com/cosenal/mailsharenewsplugin): Client-side plugin to share articles by email
+Server-side plugins:
+* [Feed Central](https://github.com/Raydiation/feedcentral): Publish your feeds as RSS
\ No newline at end of file
diff --git a/docs/developer/README.md b/docs/developer/README.md
new file mode 100644
index 000000000..2ca0d2ac6
--- /dev/null
+++ b/docs/developer/README.md
@@ -0,0 +1,6 @@
+# Developer Documentation
+As a developer you can interact with the News app in the following ways:
+
+* [External API](External-Api.md): API specification for syncing and updating feeds
+* [Plugins](Plugins.md): How to write client and server-side plugins
+* [Article enhancers](Article-Enhancers.md): Add custom CSS for a feed or add rules for full text feeds
\ No newline at end of file
diff --git a/docs/developer/external-api-v2/README.md b/docs/developer/external-api-v2/README.md
deleted file mode 100644
index 8d20bd794..000000000
--- a/docs/developer/external-api-v2/README.md
+++ /dev/null
@@ -1,734 +0,0 @@
-# External API v2 (Draft)
-
-The **News app** offers a RESTful API which can be used to sync folders, feeds and items. The API also supports [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) which means that you can access the API from your browser using JavaScript.
-
-In addition, an updater API is exposed which enables API users to run feed updates in parallel using a REST API or ownCloud console API.
-
-## Conventions
-This document uses the following conventions:
-
-* Object aliases as comments
-* Error objects are omitted
-
-### Object Aliases As Comments
-
-In order to only specify the JSON objects once, comments are used to alias them.
-
-There are two types of aliases:
-* Objects
-* Object arrays
-
-**Objects**:
-```js
-{
-    "data": {
-        "folder": { /* folder object */ },
-    }
-}
-```
-
-means that the folder attributes will be listed inside the **folder** object
-
-**Object arrays**:
-```js
-{
-    "data": {
-        "folders": [ /* array of folder objects */ ],
-    }
-}
-```
-
-means that folder objects will be listed inside the **folders** array.
-
-### Error Objects Are Omitted
-
-This means that the error object will not be explicitely shown in the examples. All HTTP 400 response status codes contain an error object:
-
-```json
-{
-    "data": { },
-    "error": {
-        "code": 1,
-        "message": "error message"
-    }
-}
-```
-
-## API Stability Contract
-
-The API level will **change** if the following occurs:
-
-* a required HTTP request header is added
-* a required request parameter is added
-* a field of a response object is removed
-* a field of a response object is changed to a different datatype
-* an HTTP response header is removed
-* an HTTP response header is changed to a different datatype
-* the meaning of an API call changes (e.g. /sync will not sync any more but show a sync timestamp)
-
-The API level will **not change** if:
-
-* a new HTTP response header is added
-* an optional new HTTP request header is added
-* a new response parameter is added (e.g. each item gets a new field "something": 1)
-* The order of the JSON attributes is changed on any level (e.g. "id":3 is not the first field anymore, but the last)
-
-You have to design your app with these things in mind!:
-
-* **Don't depend on the order** of object attributes. In JSON it does not matter where the object attribute is since you access the value by name, not by index
-* **Don't limit your app to the currently available attributes**. New ones might be added. If you don't handle them, ignore them
-* **Use a library to compare versions**, ideally one that uses semantic versioning
-
-## Authentication
-Because REST is stateless you have to re-send user and password each time you access the API. Therefore running ownCloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**.
-
-The base URL for all calls is:
-
-    https://yourowncloud.com/index.php/apps/news/api/v2
-
-All defined routes in the Specification are appended to this url. To access the sync for instance you'd use the following url:
-
-    https://yourowncloud.com/index.php/apps/news/api/v2/sync
-
-Credentials are passed as an HTTP header using [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side):
-
-    Authorization: Basic $CREDENTIALS
-
-where $CREDENTIALS is:
-
-    base64(USER:PASSWORD)
-
-This authentication/authorization method will be the recommended default until core provides an easy way to do OAuth
-
-## Request Format
-The required request headers are:
-* **Accept**: application/json
-
-Any request method except GET:
-* **Content-Type**: application/json; charset=utf-8
-
-Any route that allows caching:
-* **If-None-Match**: an Etag, e.g. 6d82cbb050ddc7fa9cbb659014546e59. If no previous Etag is known, this header should be omitted
-
-The request body is either passed in the URL in case of a **GET** request (e.g.: **?foo=bar&index=0**) or as JSON, e.g.:
-
-```json
-{
-    "foo": "bar",
-    "index": 0
-}
-```
-
-## Response Format
-The status codes are not always provided by the News app itself, but might also be returned because of ownCloud internal errors.
-
-The following status codes can always be returned by ownCloud:
-* **401**: The provided credentials to log into ownCloud are invalid.
-* **403**: The user is not allowed to access the route. This can happen if for instance of only users in the admin group can access the route and the user is not in it.
-* **404**: The route can not be found or the resource does not exist. Can also happen if for instance you are trying to delete a folder which does not exist.
-* **5xx**: An internal server error occurred. This can happen if the server is in maintenance mode or because of other reasons.
-
-The following status codes are returned by News:
-* **200**: Everything went fine
-* **304**: In case the resource was not modified, contains no response body. This means that you can ignore the request since everything is up to date.
-* **400**: There was an app related error, check the **error** object if specified
-* **409**: Conflict error which means that the resource exists already. Can be returned when updating (**PATCH**) or creating (**POST**) a resource, e.g. a folder
-
-The response headers are:
-* **Content-Type**: application/json; charset=utf-8
-* **Etag**: A string containing a cache header of maximum length 64, e.g. 6d82cbb050ddc7fa9cbb659014546e59
-
-The response body is a JSON structure that looks like this:
-
-```json
-{
-    "data": { },
-    "error": {
-        "code": 1,
-        "message": "error message"
-    }
-}
-```
-
-* **data**: Contains the payload
-* **error**: Only present when an HTTP 400 is returned to help distinguishing between error causes
-  * **code**: A unique error code
-  * **message**: A translated error message. The user's configured locale is used.
-
-In case of an **4xx** or **5xx** error the request was not successful and has to be retried. For instance marking items as read locally and syncing should send the same request again the next time the user syncs in case an error occured.
-
-## Security Guidelines
-Read the following notes carefully to prevent being subject to security exploits:
-* All string fields in a JSON response unless explicitly noted otherwise are provided in without sanitation. This means that if you do not escape it properly before rendering you will be vulnerable to [XSS](https://www.owasp.org/index.php/Cross-site_Scripting_%28XSS%29) attacks
-* Basic Auth headers can easily be decrypted by anyone since base64 is an encoding, not an encryption. Therefore only send them if you are accessing an HTTPS website or display an easy to understand warning if the user chooses HTTP
-* When creating a feed you can choose to add basic auth authentication credentials. These must be stored in clear text so anyone with access to your database (however they might have achieved it, think of Sql injection) can read them and use them to access the website. You should warn the user about this.
-
-## Syncing
-All routes are given relative to the base API url, e.g.: **/sync** becomes  **https://yourowncloud.com/index.php/apps/news/api/v2/sync**
-
-There are two usecases for syncing:
-* **Initial sync**: the user does not have any data at all
-* **Syncing local and remote changes**: the user has synced at least once and wants to submit and receive changes
-
-### Initial Sync
-The intial sync happens when a user adds an ownCloud account in your app. In that case you want to download all folders, feeds and unread/starred items. To do this, make the following request:
-
-* **Method**: GET
-* **Route**: /sync
-* **Authentication**: [required](#authentication)
-* **HTTP headers**:
-  * **Accept: "application/json"**
-
-This will return the following status codes:
-* **200**: Success
-
-and the following HTTP headers:
-* **Content-Type**: application/json; charset=utf-8
-* **Etag**: A string containing a cache header, maximum size 64 ASCII characters, e.g. 6d82cbb050ddc7fa9cbb659014546e59
-
-and the following request body:
-```js
-{
-    "data": {
-        "folders": [ /* array of folder objects */ ],
-        "feeds": [ /* array of feed objects */ ],
-        "items": [ /* array of item objects */ ]
-    }
-}
-```
-
-**Hint**: Each object is explained in more detail in a separate section:
-* [Folders](#folders)
-* [Feeds](#feeds)
-* [Items](#items)
-
-
-### Sync Local And Remote Changes
-After the initial sync the app has all folders, feeds and items. Now you want to push changes and retrieve updates from the server. To do this, make the following request:
-
-* **Method**: POST
-* **Route**: /sync
-* **Authentication**: [required](#authentication)
-* **HTTP headers**:
-  * **Content-Type: "application/json; charset=utf-8"**
-  * **Accept: "application/json"**
-  * **If-None-Match: "6d82cbb050ddc7fa9cbb659014546e59"** (Etag from the previous request to the /sync route)
-
-with the following request body:
-
-```js
-{
-    "items": [{
-            // read and starred
-            "id": 5,
-            "isStarred": false,
-            "isRead": true,
-            "fingerprint": "08ffbcf94bd95a1faa6e9e799cc29054"
-        }, {
-            // only read
-            "id": 6,
-            "isRead": true,
-            "fingerprint": "09ffbcf94bd95a1faa6e9e799cc29054"
-        }, {
-            // only starred
-            "id": 7,
-            "isStarred": false,
-            "fingerprint": "18ffbcf94bd95a1faa6e9e799cc29054"
-    }, /* etc */]
-}
-```
-
-If no items have been read or starred, simply leave the **items** array empty, e.g.:
-
-```js
-{
-    "items": []
-}
-```
-
-The response matches the **GET** call, except there can be two different types of item objects:
-* **[Full](#full)**: Contains all attributes
-* **[Reduced](#reduced)**: Contains only **id**, **isRead** and **isStarred**
-
-The deciding factor whether a full or reduced item object is being returned depends on the fingerprint in the request: If the fingerprint matches the record in the database a reduced item object is being returned, otherwise a full object is used. Both can occur in the same items array at the same time.
-
-The idea behind this special handling is that if the fingerprint matches the record in the database, the actual item content did not change. Therefore it is enough to know the item status. This greatly reduces the amount sent over the Net which is especially important for mobile apps.
-
-## Folders
-Folders are represented using the following data structure:
-```json
-{
-    "id": 3,
-    "name": "funny stuff"
-}
-```
-
-The attributes mean the following:
-* **id**: 64bit Integer, id
-* **name**: Abitrary long text, folder's name
-
-### Deleting A Folder
-To delete a folder, use the following request:
-* **Method**: DELETE
-* **Route**: /folders/{id}
-* **Route Parameters**:
-  * **{id}**: folder's id
-* **Authentication**: [required](#authentication)
-
-The following response is being returned:
-
-Status codes:
-* **200**: Folder was deleted successfully
-* **404**: Folder does not exist
-
-In case of an HTTP 200, the deleted folder is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "folder": { /* folder object */ }
-    }
-}
-```
-### Creating A Folder
-To create a folder, use the following request:
-* **Method**: POST
-* **Route**: /folders
-* **Authentication**: [required](#authentication)
-
-with the following request body:
-```json
-{
-    "name": "Folder name"
-}
-```
-
-The following response is being returned:
-
-Status codes:
-* **200**: Folder was created successfully
-* **400**: Folder creation error, check the error object:
-  * **code**: 1: folder name is empty
-* **409**: Folder with given name exists already
-
-In case of an HTTP 200 or 409, the created or already existing folder is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "folder": { /* folder object */ }
-    }
-}
-```
-
-### Changing A Folder
-The following attributes can be changed on the folder:
-* **name**
-
-To change any number of attributes on a folder, use the following request and provide as much attributes that can be changed as you want:
-* **Method**: PATCH
-* **Route**: /folders/{id}
-* **Route Parameters**:
-  * **{id}**: folder's id
-* **Authentication**: [required](#authentication)
-
-with the following request body:
-```json
-{
-    "name": "New folder name"
-}
-```
-
-* **name**: Abitrary long text, the folder's name
-
-The following response is being returned:
-
-Status codes:
-* **200**: Folder was created successfully
-* **400**: Folder creation error, check the error object:
-  * **code**: 1: folder name is empty
-* **409**: Folder with given name exists already
-* Other ownCloud errors, see [Response Format](#response-format)
-
-In case of an HTTP 200 or 409, the changed or already existing folder is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "folder": { /* folder object */ }
-    }
-}
-```
-
-
-## Feeds
-Feeds are represented using the following data structure:
-
-```json
-{
-    "id": 4,
-    "name": "The Oatmeal - Comics, Quizzes, & Stories",
-    "faviconLink": "http://theoatmeal.com/favicon.ico",
-    "folderId": 3,
-    "ordering": 0,
-    "fullTextEnabled": false,
-    "updateMode": 0,
-    "isPinned": true,
-    "error": {
-        "code": 1,
-        "message": ""
-    }
-}
-```
-
-The attributes mean the following:
-* **id**: 64bit Integer, id
-* **name**: Abitrary long text, feed's name
-* **faviconLink**: Abitrary long text, feed's favicon location, **null** if not found
-* **folderId**: 64bit Integer, the feed's folder or **0** in case no folder is specified
-* **ordering**: 64bit Integer, overrides the feed's default ordering:
-  * **0**: Default
-  * **1**: Oldest on top
-  * **2**: Newest on top
-* **updateMode**: 64bit Integer, describing how item updates are handled:
-  * **0**: No special behavior
-  * **1**: If an item is updated, mark it unread
-* **isPinned**: Boolean, Used to list certain feeds before others. Feeds are first ordered by their **isPinned** value (true before false) and then by their name in alphabetical order
-* **error**: error object, only present if an error occurred:
-  * **code**: The error code:
-    * **1**: Error occured during feed update
-  * **message**: Translated error message depending on the user's configured server locale
-
-
-### Deleting A Feed
-To delete a feed, use the following request:
-* **Method**: DELETE
-* **Route**: /feeds/{id}
-* **Route Parameters**:
-  * **{id}**: feed's id
-* **Authentication**: [required](#authentication)
-
-
-The following response is being returned:
-
-Status codes:
-* **200**: Feed was deleted successfully
-* **404**: Feed with given id was not found, no error object
-* Other ownCloud errors, see [Response Format](#response-format)
-
-
-In case of an HTTP 200, the deleted feed is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "feed": { /* feed object */ }
-        }
-    }
-}
-```
-
-### Creating A feed
-To create a feed, use the following request:
-* **Method**: POST
-* **Route**: /feeds
-* **Authentication**: [required](#authentication)
-
-
-with the following request body:
-```json
-{
-    "url": "https://feed.url.com",
-    "name": "Folder name",
-    "ordering": 0,
-    "isPinned": true,
-    "fullTextEnabled": false,
-    "basicAuthUser": "user",
-    "basicAuthPassword": "password"
-}
-```
-* **url**: Abitrary long text, the url needs to have the full schema e.g. https://the-url.com. In case the user omits the schema, prepending **https** is recommended
-* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
-* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
-* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
-* **ordering (optional)**: See [Feeds](#feeds)
-* **isPinned (optional)**: See [Feeds](#feeds)
-* **fullTextEnabled (optional)**: See [Feeds](#feeds)
-
-
-The following response is being returned:
-
-Status codes:
-* **200**: Feed was created successfully
-* **400**: Feed creation error, check the **error** object:
-  * **code**: 1: url is empty
-  * **code**: 2: malformed xml
-  * **code**: 3: no feed found for url (e.g. website does not have an RSS or Atom feed or direct link to feed is no feed)
-  * **code**: 4: feed format not supported (e.g. too old RSS version)
-  * **code**: 5: ssl issues (e.g. SSL certificate is invalid or php has issues accessing certificates on your server)
-  * **code**: 6: url can not be found or accessed
-  * **code**: 7: maximum redirects reached
-  * **code**: 8: maximum size reached
-  * **code**: 9: request timed out
-  * **code**: 10: invalid or missing http basic auth headers
-  * **code**: 11: not allowed to access the feed (difference here is that the user can be authenticated but not allowed to access the feed)
-
-In case of an HTTP 200, the created feed is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "feed": { /* feed object */ }
-    }
-}
-```
-
-
-### Changing A Feed
-To change a feed, use the following request:
-* **Method**: PATCH
-* **Route**: /feeds/{id}
-* **Route Parameters**:
-  * **{id}**: feed's id
-* **Authentication**: [required](#authentication)
-
-
-with the following request body:
-```json
-{
-    "url": "https://feed.url.com",
-    "name": "Folder name",
-    "ordering": 0,
-    "isPinned": true,
-    "fullTextEnabled": false,
-    "basicAuthUser": "user",
-    "basicAuthPassword": "password"
-}
-```
-
-All parameters are optional
-
-* **url (optional)**: Abitrary long text, the url which was entered by the user with the full schema
-* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
-* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
-* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
-* **ordering (optional)**: See [feeds](#Feeds)
-* **isPinned (optional)**: See [feeds](#Feeds)
-* **fullTextEnabled (optional)**: See [feeds](#Feeds)
-
-The following response is being returned:
-
-Status codes:
-* **200**: Feed was changed successfully
-* **400**: Feed creation error, check the error object:
-  * **code**: 1: url is empty
-  * **code**: 2: malformed xml
-  * **code**: 3: no feed found for url (e.g. website does not have an RSS or Atom feed or direct link to feed is no feed)
-  * **code**: 4: feed format not supported (e.g. too old RSS version)
-  * **code**: 5: ssl issues (e.g. SSL certificate is invalid or php has issues accessing certificates on your server)
-  * **code**: 6: url can not be found or accessed
-  * **code**: 7: maximum redirects reached
-  * **code**: 8: maximum size reached
-  * **code**: 9: request timed out
-  * **code**: 10: invalid or missing http basic auth headers
-  * **code**: 11: not allowed to access the feed (difference here is that the user can be authenticated but not allowed to access the feed)
-* Other ownCloud errors, see [Response Format](#response-format)
-
-In case of an HTTP 200, the changed feed is returned in full in the response, e.g.:
-
-```js
-{
-    "data": {
-        "feed": { /* feed object */ }
-    }
-}
-```
-
-## Items
-
-Items can occur in two different formats:
-
-* Full
-* Reduced
-
-The attributes mean the following:
-* **id**: 64bit Integer, id
-* **url**: Abitrary long text, location of the online resource
-* **title**: Abitrary long text, item's title
-* **author**: Abitrary long text, name of the author/authors
-* **publishedAt**: String representing an ISO 8601 DateTime object, when the item was published
-* **updatedAt**: String representing an ISO 8601 DateTime object, when the item was updated
-* **enclosures**: A list of enclosure objects,
-  * **mime**: Mimetype
-  * **url**: Abitrary long text, location of the enclosure
-* **body**: Abitrary long text, **sanitized (meaning: does not have to be escape)**, contains the item's content
-* **feedId**: 64bit Integer, the item's feed it belongs to
-* **isUnread**: Boolean, true if unread, false if read
-* **isStarred**: Boolean, true if starred, false if not starred
-* **fingerprint**: 64 ASCII characters, hash that is used to determine if an item is the same as an other one. The following behavior should be implemented:
-  * Items in a stream (e.g. All items, folders, feeds) should be filtered so that no item with the same fingerprint is present.
-  * When marking an item read, all items with the same fingerprint should also be marked as read.
-
-### Full
-A full item contains the full content:
-```json
-{
-    "id": 5,
-    "url": "http://grulja.wordpress.com/2013/04/29/plasma-nm-after-the-solid-sprint/",
-    "title": "Plasma-nm after the solid sprint",
-    "author": "Jan Grulich (grulja)",
-    "publishedAt": "2005-08-15T15:52:01+0000",
-    "updatedAt": "2005-08-15T15:52:01+0000",
-    "enclosures": [{
-        "mime": "video/webm",
-        "url": "http://video.webmfiles.org/elephants-dream.webm"
-    }],
-    "body": "<p>At first I have to say...</p>",
-    "feedId": 4,
-    "isUnread": true,
-    "isStarred": true,
-    "fingerprint": "08ffbcf94bd95a1faa6e9e799cc29054"
-}
-```
-
-### Reduced
-A reduced item only contains the item status:
-```json
-{
-    "id": 5,
-    "isUnread": true,
-    "isStarred": true
-}
-```
-
-## Updater
-Instead of using the built in, slow cron updater you can use the parallel update API to update feeds. The API can be accessed through REST or ownCloud console API.
-
-The API should be used in the following way:
-
-* Clean up before the update
-* Get all feeds and user ids
-* For each feed and user id, run the update
-* Clean up after the update
-
-The reference [implementation in Python](https://github.com/owncloud/news-updater) should give you a good idea how to design your own updater.
-
-If the REST API is used, Authorization is required via Basic Auth and the user needs to be in the admin group.
-If the ownCloud console API is used, no authorization is required.
-
-### Clean Up Before Update
-This is used to clean up the database. It deletes folders and feeds that are marked for deletion.
-
-**Console API**:
-
-    php -f /path/to/owncloud/occ news:updater:before-update
-
-**REST API**:
-
-* **Method**: GET
-* **Route**: /updater/before-update
-* **Authentication**: [admin](#authentication)
-
-### Get All Feeds And User Ids
-This call returns pairs of feed ids and user ids.
-
-**Console API**:
-
-    php -f /path/to/owncloud/occ news:updater:all-feeds
-
-**REST API**:
-
-* **Method**: GET
-* **Route**: /updater/all-feeds
-* **Authentication**: [admin](#authentication)
-
-
-Both APIs will return the following response body or terminal output:
-
-```js
-{
-    "data": {
-        "updater": [{
-          "feedId": 3,
-          "userId": "john"
-        }, /* etc */]
-    }
-}
-```
-
-### Update A User's Feed
-After all feed ids and user ids are known, feeds can be updated in parallel.
-
-**Console API**:
-* **Positional Parameters**:
-  * **{feedId}**: the feed's id
-  * **{userId}**: the user's id
-
-
-    php -f /path/to/owncloud/occ news:updater:update-feed {feedId} {userId}
-
-**REST API**:
-
-* **Method**: GET
-* **Route**: /updater/update-feed?feedId={feedId}&userId={userId}
-* **Route Parameters**:
-  * **{feedId}**: the feed's id
-  * **{userId}**: the user's id
-* **Authentication**: [admin](#authentication)
-
-
-### Clean Up After Update
-This is used to clean up the database. It removes old read articles which are not starred.
-
-**Console API**:
-
-    php -f /path/to/owncloud/occ news:updater:after-update
-
-**REST API**:
-
-* **Method**: GET
-* **Route**: /updater/after-update
-* **Authentication**: [admin](#authentication)
-
-## Meta Data
-The retrieve meta data about the app, use the following request:
-
-* **Method**: GET
-* **Route**: /
-* **Authentication**: [required](#authentication)
-
-
-The following response is being returned:
-
-Status codes:
-* **200**: Meta data accessed successfully
-
-In case of an HTTP 200, the the following response is returned:
-
-```json
-{
-    "version": "9.0.0",
-    "issues": {
-        "improperlyConfiguredCron": false
-    },
-    "user": {
-        "userId": "john",
-        "displayName": "John Doe",
-        "avatar": {
-            "data": "asdiufadfasdfjlkjlkjljdfdf",
-            "mime": "image/jpeg"
-        }
-    }
-}
-```
-
-The attributes mean the following:
-* **version**: Abitrary long text, News app version
-* **issues**: An object containing a dictionary of issues which need to be displayed to the user:
-  * **improperlyConfiguredCron**: Boolean, if true this means that no feed updates are run on the server because the updater is misconfigured
-* **user**: user information:
-  * **userId**: Abitrary long text, the login name
-  * **displayName**: Abitrary long text, the full name like it's displayed in the web interface
-  * **avatar**: an avatar object, null if none is set
-    * **data**: Abitrary long text, the user's image encoded as base64
-    * **mime**: Abitrary long text, avatar mimetype
diff --git a/docs/developer/plugins/README.md b/docs/developer/plugins/README.md
deleted file mode 100644
index 22d29efa7..000000000
--- a/docs/developer/plugins/README.md
+++ /dev/null
@@ -1,202 +0,0 @@
-# How To Write Plugins
-
-Plugins were created to keep the app maintainable while still making it possible to easily implement additional functionality.
-
-There are essentially three different use cases for plugins:
-* Creating or extending server-side functionality, e.g. creating additional REST API endpoints
-* Offering article actions such as share via Twitter or E-Mail
-* Dropping in additional CSS or JavaScript
-
-## The Basics
-Whatever plugin you want to create, you first need to create a basic structure. A plugin is basically  just an app so you can take advantage of the full [ownCloud app API](https://doc.owncloud.org/server/9.0/developer_manual/app/index.html). If you want you can [take a look at the developer docs](https://doc.owncloud.org/server/9.0/developer_manual/app/index.html) or [dig into the tutorial](http://doc.owncloud.org/server/9.0/developer_manual/app/appframework/tutorial.html).
-
-However if you just want to start slow, the full process is described below.
-
-First create the following directories and files:
-
-* **newsplugin/**
-  * **appinfo/**
-     * **app.php**
-     * **info.xml**
-
-The first folder name affects the name and namespace of your plugin and only one app can exist using the same name. Choose wisely.
-
-First let's add some meta data about our app. Open the **newsplugin/appinfo/info.xml** and add the following contents:
-
-```xml
-<?xml version="1.0"?>
-<info>
-    <id>newsplugin</id>
-    <name>Example News Plugin</name>
-    <description>This plugin allows you to share articles via Twitter</description>
-    <licence>AGPL</licence>
-    <author>Your Name Here</author>
-    <version>0.0.1</version>
-    <dependencies>
-        <owncloud min-version="9.0"/>
-        <php min-version="5.6"/>
-    </dependencies>
-</info>
-```
-
-**Note**: You must license