From 4c017a79cc160998668712d1e578e3c817616fa2 Mon Sep 17 00:00:00 2001 From: anoy Date: Wed, 12 May 2021 18:42:50 +0200 Subject: fix lists for mkdocs Signed-off-by: anoy --- docs/api/api-v1.md | 1 + docs/faq.md | 1 + docs/features/plugins.md | 8 +++++--- docs/install.md | 2 ++ 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/api/api-v1.md b/docs/api/api-v1.md index 84bdb476f..fd39a8acd 100644 --- a/docs/api/api-v1.md +++ b/docs/api/api-v1.md @@ -629,6 +629,7 @@ This is used to stay up to date. To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created. Updating should be done in the following fashion: + * Run the cleanup before the update * Get all feeds and user ids * For each feed and user id, run the update command diff --git a/docs/faq.md b/docs/faq.md index 3063922dc..c460a5650 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -14,6 +14,7 @@ Note that this warning **is not red and won't block the page like the following ### What is the cause of the (yellow) error message This warning is caused by [mixed passive content](https://developer.mozilla.org/en/docs/Security/MixedContent) and means that your page loads passive resources from non HTTPS resources, such as: + * Images * Video/Audio diff --git a/docs/features/plugins.md b/docs/features/plugins.md index 25a22748a..ba5f46d18 100644 --- a/docs/features/plugins.md +++ b/docs/features/plugins.md @@ -3,6 +3,7 @@ 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 @@ -15,9 +16,9 @@ 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** + * **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. @@ -102,6 +103,7 @@ News.addArticleAction(function($actionsElement, article) { ``` 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 diff --git a/docs/install.md b/docs/install.md index 5ea2d3416..a228b6b27 100644 --- a/docs/install.md +++ b/docs/install.md @@ -29,6 +29,7 @@ Also see the [Nextcloud documentation](https://docs.nextcloud.com/server/stable/ ## Before you install/update the News app Before you install the app do the following: + * Check that your **nextcloud/data/** directory is owned by your web server user and that it is write/readable * Check that your installation fulfills the [requirements listed in the README section](https://github.com/nextcloud/news#dependencies) * [Set up Nextcloud Background Jobs](https://docs.nextcloud.org/server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron) to enable feed updates. @@ -58,6 +59,7 @@ This is the easiest solution: Simply go the the apps page (section: "Multimedia" ### Build Dependencies These Dependencies are only relevant if you want to build the source code: + * make * which * Node.js >= 6 -- cgit v1.2.3