From 05604d92c7f2e5367768bb7a40668a3f50d76bd8 Mon Sep 17 00:00:00 2001 From: Maxence Lange Date: Fri, 25 Feb 2022 12:29:52 -0100 Subject: docs Signed-off-by: Maxence Lange --- docs/api/collections.md | 3 +++ docs/commands.md | 3 +++ docs/configuration.md | 3 +++ docs/elasticsearch-readonlyrest.yml | 23 ----------------------- docs/index.md | 3 +++ docs/installation.md | 3 +++ mkdocs.yml | 24 ++++++++++++++++++++++++ 7 files changed, 39 insertions(+), 23 deletions(-) create mode 100644 docs/api/collections.md create mode 100644 docs/commands.md create mode 100644 docs/configuration.md delete mode 100644 docs/elasticsearch-readonlyrest.yml create mode 100644 docs/index.md create mode 100644 docs/installation.md create mode 100644 mkdocs.yml diff --git a/docs/api/collections.md b/docs/api/collections.md new file mode 100644 index 0000000..5457629 --- /dev/null +++ b/docs/api/collections.md @@ -0,0 +1,3 @@ + +# Collections + diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 0000000..a301af2 --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,3 @@ + +# Commands + diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..fb649b5 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,3 @@ + +# Configuration + diff --git a/docs/elasticsearch-readonlyrest.yml b/docs/elasticsearch-readonlyrest.yml deleted file mode 100644 index 8a3cf8e..0000000 --- a/docs/elasticsearch-readonlyrest.yml +++ /dev/null @@ -1,23 +0,0 @@ -readonlyrest: - - access_control_rules: - - - name: Accept requests from cloud1 on my_index - groups: ["cloud1"] - indices: ["my_index"] - - - name: Accept requests from cloud2 on another_index - groups: ["cloud2"] - indices: ["another_index"] - - users: - - - username: username - auth_key: username:password - groups: ["cloud1"] - - - username: test - auth_key_sha1: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 - groups: ["cloud2"] - - diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d74fcc9 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ + +# Nextcloud FullTextSearch + diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..5b6beb4 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,3 @@ + +# Installation + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..87c07b6 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,24 @@ +site_name: Nextcloud FullTextSearch + +theme: + name: readthedocs + highlightjs: true + hljs_languages: + - php + - js + - bash + +markdown_extensions: + - admonition + - def_list + - toc: + permalink: "#" + baselevel: 2 + +nav: + - 'Nextcloud FullTextSearch': 'index.md' + - 'Installation': 'installation.md' + - 'Configuration': 'configuration.mnd' + - Commands: 'commands.md' + - 'API documentation': + - 'Collections': 'api/collections.md' -- cgit v1.2.3