From eedd63ccd504099836d9f528d02daffa6bc826ad Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 16:42:13 +0100 Subject: docs: revision of the installation instructions Signed-off-by: Markus Heiser --- docs/user/index.rst | 3 ++- docs/user/own-instance.rst | 6 ++++-- docs/user/public_instances.rst | 8 ++++++-- 3 files changed, 12 insertions(+), 5 deletions(-) (limited to 'docs/user') diff --git a/docs/user/index.rst b/docs/user/index.rst index 329be3b10..ac8731a69 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -3,7 +3,8 @@ User documentation ================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents public_instances search_syntax diff --git a/docs/user/own-instance.rst b/docs/user/own-instance.rst index a2f736562..4876abe99 100644 --- a/docs/user/own-instance.rst +++ b/docs/user/own-instance.rst @@ -2,8 +2,10 @@ Why use a private instance? =========================== -"Is it worth to run my own instance?" is a common question among searx users. -Before answering this question, see what options a searx user has. + *"Is it worth to run my own instance?"* + +\.\. is a common question among searx users. Before answering this question, +see what options a searx user has. Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users' point of view). Private diff --git a/docs/user/public_instances.rst b/docs/user/public_instances.rst index 9665c58b7..a5a7b307d 100644 --- a/docs/user/public_instances.rst +++ b/docs/user/public_instances.rst @@ -1,16 +1,20 @@ -.. _public instances: - .. links has been ported from markdown to reST by:: regexpr: \[([^\]]*)\]\(([^)]*)\) substitution: `\1 <\2>`__ +.. _public instances: ====================== Public Searx instances ====================== +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + .. _mailing list: mailto:searx-instances@autistici.org .. _subscription page: https://www.autistici.org/mailman/listinfo/searx-instances -- cgit v1.2.3 From 2d956696e94e5639db6e12648442989919c48c22 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 21 Mar 2020 18:45:38 +0100 Subject: docs: building (PDF) books / build user book BTW: cleaned up Makefile target help Signed-off-by: Markus Heiser --- docs/user/conf.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/user/conf.py (limited to 'docs/user') diff --git a/docs/user/conf.py b/docs/user/conf.py new file mode 100644 index 000000000..d4bdb576b --- /dev/null +++ b/docs/user/conf.py @@ -0,0 +1,19 @@ +# -*- coding: utf-8; mode: python -*- +"""Configuration for the CDB 15 Infrastruktur book +""" +project = 'Searx User-HB' +version = release = VERSION_STRING + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index' # startdocname + , 'searx-user-hb.tex' # targetname + , '' # take title from .rst + , author # author + , 'howto' # documentclass + , False # toctree_only + ), +] + -- cgit v1.2.3 From a5e82f98013eb76acc373c397bec7c694adad403 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:57:10 +0200 Subject: [fix] margial typo in docs/user/onf.py doc-string Signed-off-by: Markus Heiser --- docs/user/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user') diff --git a/docs/user/conf.py b/docs/user/conf.py index d4bdb576b..53ade4b63 100644 --- a/docs/user/conf.py +++ b/docs/user/conf.py @@ -1,5 +1,5 @@ # -*- coding: utf-8; mode: python -*- -"""Configuration for the CDB 15 Infrastruktur book +"""Configuration for the Searx user handbook """ project = 'Searx User-HB' version = release = VERSION_STRING -- cgit v1.2.3 From 2addee3893d236d2be08d28a4fb61d6f24b478bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?No=C3=A9mi=20V=C3=A1nyi?= Date: Sun, 28 Jun 2020 11:40:04 +0200 Subject: Use gender neutral pronouns Closes #2031 --- docs/user/own-instance.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/user') diff --git a/docs/user/own-instance.rst b/docs/user/own-instance.rst index 4876abe99..af415b61d 100644 --- a/docs/user/own-instance.rst +++ b/docs/user/own-instance.rst @@ -44,9 +44,9 @@ hidden from visited result pages. What are the consequences of using public instances? ---------------------------------------------------- -If someone uses a public instance, he/she has to trust the administrator of that +If someone uses a public instance, they have to trust the administrator of that instance. This means that the user of the public instance does not know whether -his/her requests are logged, aggregated and sent or sold to a third party. +their requests are logged, aggregated and sent or sold to a third party. Also, public instances without proper protection are more vulnerable to abusing the search service, In this case the external service in exchange returns -- cgit v1.2.3