diff options
author | Markus Heiser <markus.heiser@darmarit.de> | 2021-04-25 12:03:54 +0200 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarit.de> | 2021-04-25 14:25:08 +0200 |
commit | 28b25185c51d320c8124292a6194e4c34fa9c3e8 (patch) | |
tree | a0cbe498f1c0a6a7be6e0f15c1b271e981be82cf /docs | |
parent | c6a5cc019ae27b1892b38afd33090653d07f33be (diff) | |
download | searxng-28b25185c51d320c8124292a6194e4c34fa9c3e8.tar.gz searxng-28b25185c51d320c8124292a6194e4c34fa9c3e8.zip |
[brand] searxng -- fix links to issue tracker & WEB-GUI
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/admin/arch_public.dot | 8 | ||||
-rw-r--r-- | docs/admin/architecture.rst | 2 | ||||
-rw-r--r-- | docs/admin/installation-searx.rst | 2 | ||||
-rw-r--r-- | docs/admin/installation.rst | 2 | ||||
-rw-r--r-- | docs/admin/settings.rst | 15 | ||||
-rw-r--r-- | docs/blog/command-line-engines.rst | 2 | ||||
-rw-r--r-- | docs/blog/intro-offline.rst | 2 | ||||
-rw-r--r-- | docs/blog/lxcdev-202006.rst | 2 | ||||
-rw-r--r-- | docs/blog/private-engines.rst | 6 | ||||
-rw-r--r-- | docs/blog/python3.rst | 2 | ||||
-rw-r--r-- | docs/build-templates/searx.rst | 2 | ||||
-rw-r--r-- | docs/conf.py | 7 | ||||
-rw-r--r-- | docs/dev/quickstart.rst | 2 | ||||
-rw-r--r-- | docs/dev/reST.rst | 4 | ||||
-rw-r--r-- | docs/index.rst | 2 |
15 files changed, 30 insertions, 30 deletions
diff --git a/docs/admin/arch_public.dot b/docs/admin/arch_public.dot index 0d826078d..b838685e7 100644 --- a/docs/admin/arch_public.dot +++ b/docs/admin/arch_public.dot @@ -4,11 +4,11 @@ digraph G { edge [fontname="Sans"]; browser [label="Browser", shape=Mdiamond]; - rp [label="Reverse Proxy", href="https://searx.github.io/searx/utils/filtron.sh.html#public-reverse-proxy"]; - filtron [label="Filtron", href="https://searx.github.io/searx/utils/filtron.sh.html"]; - morty [label="Morty", href="https://searx.github.io/searx/utils/morty.sh.html"]; + rp [label="Reverse Proxy", href="https://searxng.github.io/searxng/utils/filtron.sh.html#public-reverse-proxy"]; + filtron [label="Filtron", href="https://searxng.github.io/searxng/utils/filtron.sh.html"]; + morty [label="Morty", href="https://searxng.github.io/searxng/utils/morty.sh.html"]; static [label="Static files", href="url to configure static files"]; - uwsgi [label="uwsgi", href="https://searx.github.io/searx/utils/searx.sh.html"] + uwsgi [label="uwsgi", href="https://searxng.github.io/searxng/utils/searx.sh.html"] searx1 [label="Searx #1"]; searx2 [label="Searx #2"]; searx3 [label="Searx #3"]; diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst index 464e765eb..edc518ab1 100644 --- a/docs/admin/architecture.rst +++ b/docs/admin/architecture.rst @@ -16,7 +16,7 @@ Architecture Herein you will find some hints and suggestions about typical architectures of searx infrastructures. -We start with a contribution from :pull:`@dalf <1776#issuecomment-567917320>`. +We start with a contribution from :pull-searx:`@dalf <1776#issuecomment-567917320>`. It shows a *reference* setup for public searx instances which can build up and maintained by the scripts from our :ref:`toolboxing`. diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index adea0166f..5c9985e8b 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -80,7 +80,7 @@ Configuration To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup :ref:`use default settings <settings use_default_settings>` from -:origin:`searx/settings.yml` and is recommended since :pull:`2291` is merged. +:origin:`searx/settings.yml` and is recommended since :pull-searx:`2291` is merged. For a *minimal setup*, configure like shown below – replace ``searx@$(uname -n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 9bb102c42..722458152 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -42,7 +42,7 @@ the case if you clone into a folder below ``/root``. .. code:: bash $ cd ~/Downloads - $ git clone https://github.com/searx/searx searx + $ git clone https://github.com/searxng/searxng.git searx $ cd searx .. sidebar:: further read diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index 622218279..d0773467d 100644 --- a/docs/admin/settings.rst +++ b/docs/admin/settings.rst @@ -43,15 +43,16 @@ Global Settings general: debug : False # Debug mode, only for development - instance_name : "searx" # displayed name - git_url: https://github.com/searx/searx + instance_name : "searxng" # displayed name + contact_url: False # mailto:contact@example.com + + brand: + git_url: https://github.com/searxng/searxng git_branch: master - issue_url: https://github.com/searx/searx/issues - docs_url: https://searx.github.io/searx + issue_url: https://github.com/searxng/searxng/issues + docs_url: https://searxng/searxng.github.io/searxng public_instances: https://searx.space - contact_url: False # mailto:contact@example.com - wiki_url: https://github.com/searx/searx/wiki - twitter_url: https://twitter.com/Searx_engine + wiki_url: https://github.com/searxng/searxng/wiki ``debug`` : Allow a more detailed log if you run searx directly. Display *detailed* error diff --git a/docs/blog/command-line-engines.rst b/docs/blog/command-line-engines.rst index 746c9e4ae..09eb84fb4 100644 --- a/docs/blog/command-line-engines.rst +++ b/docs/blog/command-line-engines.rst @@ -10,7 +10,7 @@ connecting to any networks from the same graphical user interface. Command line engines ==================== -In :pull:`2128` a new type of engine has been introduced called ``command``. +In :pull-searx:`2128` a new type of engine has been introduced called ``command``. This engine lets administrators add engines which run arbitrary shell commands and show its output on the web UI of searx. diff --git a/docs/blog/intro-offline.rst b/docs/blog/intro-offline.rst index f6e90de3a..3a706d038 100644 --- a/docs/blog/intro-offline.rst +++ b/docs/blog/intro-offline.rst @@ -56,7 +56,7 @@ As offline searches can return arbitrary results depending on the engine, the current result templates were insufficient to present such results. Thus, a new template is introduced which is caplable of presenting arbitrary key value pairs as a table. You can check out the pull request for more details see -:pull:`1700`. +:pull-searx:`1700`. Next steps ========== diff --git a/docs/blog/lxcdev-202006.rst b/docs/blog/lxcdev-202006.rst index b53501dab..24d9028c2 100644 --- a/docs/blog/lxcdev-202006.rst +++ b/docs/blog/lxcdev-202006.rst @@ -81,7 +81,7 @@ fork: .. code:: sh $ cd ~/Downloads - $ git clone https://github.com/searx/searx.git + $ git clone https://github.com/searxng/searxng.git searx $ cd searx The :ref:`lxc-searx.env` consists of several images, see ``export diff --git a/docs/blog/private-engines.rst b/docs/blog/private-engines.rst index 027cc3dd3..37b1d4cc5 100644 --- a/docs/blog/private-engines.rst +++ b/docs/blog/private-engines.rst @@ -12,7 +12,7 @@ would rather share engines only with their trusted friends or colleagues. Private engines =============== -To solve this issue private engines were introduced in :pull:`1823`. +To solve this issue private engines were introduced in :pull-searx:`1823`. A new option was added to engines named `tokens`. It expects a list of strings. If the user making a request presents one of the tokens of an engine, they can access information about the engine @@ -29,7 +29,7 @@ Example configuration to restrict access to the Arch Linux Wiki engine: Unless a user has configured the right token, the engine is going -to be hidden from him/her. It is not going to be included in the +to be hidden from him/her. It is not going to be included in the list of engines on the Preferences page and in the output of `/config` REST API call. @@ -42,7 +42,7 @@ is not carved in stone. As providing access to such engines implies that the admin knows and trusts the user, we do not see necessary to come up with a strict process. Instead, we would like to add guidelines to the documentation of the feature. - + Next steps ========== diff --git a/docs/blog/python3.rst b/docs/blog/python3.rst index 1d2cfc813..7e770c193 100644 --- a/docs/blog/python3.rst +++ b/docs/blog/python3.rst @@ -54,7 +54,7 @@ If you found bugs Please open an issue on `GitHub`_. Make sure that you mention your Python version in your issue, so we can investigate it properly. -.. _GitHub: https://github.com/searx/searx/issues +.. _GitHub: https://github.com/searxng/searxng/issues Acknowledgment ============== diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst index e06bc2c6a..ead096ed8 100644 --- a/docs/build-templates/searx.rst +++ b/docs/build-templates/searx.rst @@ -81,7 +81,7 @@ ${fedora_build} .. code-block:: sh $ sudo -H -u ${SERVICE_USER} -i - (${SERVICE_USER})$ git clone \"https://github.com/searx/searx.git\" \"$SEARX_SRC\" + (${SERVICE_USER})$ git clone \"$GIT_URL\" \"$SEARX_SRC\" .. END clone searx diff --git a/docs/conf.py b/docs/conf.py index e3379ec8e..998b07ff1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,8 +38,9 @@ jinja_contexts = { extlinks = {} # upstream links -extlinks['wiki'] = ('https://github.com/searx/searx/wiki/%s', ' ') -extlinks['pull'] = ('https://github.com/searx/searx/pull/%s', 'PR ') +extlinks['wiki'] = ('https://github.com/searxng/searxng/wiki/%s', ' ') +extlinks['pull'] = ('https://github.com/searxng/searxng/pull/%s', 'PR ') +extlinks['pull-searx'] = ('https://github.com/searx/searx/pull/%s', 'PR ') # links to custom brand extlinks['origin'] = (brand.GIT_URL + '/blob/' + brand.GIT_BRANCH + '/%s', 'git://') @@ -84,7 +85,7 @@ intersphinx_mapping = { "sphinx" : ("https://www.sphinx-doc.org/en/master/", None), } -issues_github_path = "searx/searx" +issues_github_path = "searxng/searxng" # HTML ----------------------------------------------------------------- diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index bb9f4d67c..74bb52960 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -11,7 +11,7 @@ you simply by using :ref:`make <makefile>`. .. code:: sh - git clone https://github.com/searx/searx.git + git clone https://github.com/searxng/searxng.git searx Here is how a minimal workflow looks like: diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 1817504c6..181d9829d 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -288,7 +288,7 @@ content becomes smart. project's wiki article :wiki:`Offline-engines` ``:wiki:`Offline-engines``` to docs public URL :docs:`dev/reST.html` ``:docs:`dev/reST.html``` files & folders origin :origin:`docs/dev/reST.rst` ``:origin:`docs/dev/reST.rst``` - pull request :pull:`1756` ``:pull:`1756``` + pull request :pull:`4` ``:pull:`4``` patch :patch:`af2cae6` ``:patch:`af2cae6``` PyPi package :pypi:`searx` ``:pypi:`searx``` manual page man :man:`bash` ``:man:`bash``` @@ -320,7 +320,7 @@ To list all anchors of the inventory (e.g. ``python``) use: $ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv ... - $ python -m sphinx.ext.intersphinx https://searx.github.io/searx/objects.inv + $ python -m sphinx.ext.intersphinx https://searxng.github.io/searxng/objects.inv ... Literal blocks diff --git a/docs/index.rst b/docs/index.rst index 35a2e0a5f..862106ebe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,8 +23,6 @@ anyone, you can set up your own, see :ref:`installation`. - Easy integration with any search engine - Cookies are not used by default - Secure, encrypted connections (HTTPS/SSL) - - Hosted by organizations, such as *La Quadrature du Net*, which promote - digital rights .. toctree:: :maxdepth: 2 |