Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit b12d8261 authored by Markus Heiser's avatar Markus Heiser Committed by GitHub
Browse files

Merge pull request #2358 from spalinger/patch-2 

fix typos/grammar in docs
parents 3ba05876 1918fb2e

docs/admin/buildhosts.rst

+3 −3
Original line number Original line Diff line number Diff line
@@ -14,7 +14,7 @@ Buildhosts 
   :local:

   :local:

   :backlinks: entry

   :backlinks: entry





To get best results from build, its recommend to install additional packages

To get best results from build, it's recommend to install additional packages

on build hosts (see :ref:`searxng.sh`).::

on build hosts (see :ref:`searxng.sh`).::





  sudo -H ./utils/searxng.sh install buildhost

  sudo -H ./utils/searxng.sh install buildhost
@@ -51,7 +51,7 @@ Build docs 
Most of the sphinx requirements are installed from :origin:`setup.py` and the

Most of the sphinx requirements are installed from :origin:`setup.py` and the

docs can be build from scratch with ``make docs.html``.  For better math and

docs can be build from scratch with ``make docs.html``.  For better math and

image processing additional packages are needed.  The XeTeX_ needed not only for

image processing additional packages are needed.  The XeTeX_ needed not only for

PDF creation, its also needed for :ref:`math` when HTML output is build.

PDF creation, it's also needed for :ref:`math` when HTML output is build.





To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered

To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered

as images (``sphinx.ext.imgmath`` extension).

as images (``sphinx.ext.imgmath`` extension).
@@ -128,7 +128,7 @@ Lint shell scripts 




.. _ShellCheck: https://github.com/koalaman/shellcheck

.. _ShellCheck: https://github.com/koalaman/shellcheck





To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool.

To lint shell scripts, we use ShellCheck_ - a shell script static analysis tool.





.. SNIP sh lint requirements

.. SNIP sh lint requirements

docs/admin/installation-docker.rst

+1 −1
Original line number Original line Diff line number Diff line
@@ -123,7 +123,7 @@ stoped. To get rid of a container use ``container rm``: 




   This might remove all docker items, not only those from SearXNG.

   This might remove all docker items, not only those from SearXNG.





If you won't use docker anymore and want to get rid of all conatiners & images

If you won't use docker anymore and want to get rid of all containers & images

use the following *prune* command:

use the following *prune* command:





.. code:: sh

.. code:: sh

docs/admin/installation-scripts.rst

+2 −2
Original line number Original line Diff line number Diff line
@@ -42,7 +42,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the 
   For the installation procedure, use a *sudoer* login to run the scripts.  If

   For the installation procedure, use a *sudoer* login to run the scripts.  If

   you install from ``root``, take into account that the scripts are creating a

   you install from ``root``, take into account that the scripts are creating a

   ``searxng`` user.  In the installation procedure this new created user does

   ``searxng`` user.  In the installation procedure this new created user does

   need read access to the cloned SearXNG repository, which is not the case if you clone

   need to have read access to the cloned SearXNG repository, which is not the case if you clone

   it into a folder below ``/root``!

   it into a folder below ``/root``!





.. sidebar:: further read

.. sidebar:: further read
@@ -52,7 +52,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the 
.. _caddy: https://hub.docker.com/_/caddy

.. _caddy: https://hub.docker.com/_/caddy





When all services are installed and running fine, you can add SearXNG to your

When all services are installed and running fine, you can add SearXNG to your

HTTP server.  We do not have any preferences for the HTTP server, you can use

HTTP server.  We do not have any preferences regarding the HTTP server, you can use

whatever you prefer.

whatever you prefer.





We use caddy in our :ref:`docker image <installation docker>` and we have

We use caddy in our :ref:`docker image <installation docker>` and we have

docs/admin/installation.rst

+1 −1
Original line number Original line Diff line number Diff line
@@ -12,7 +12,7 @@ Installation 




The :ref:`installation basic` is an excellent illustration of *how a SearXNG

The :ref:`installation basic` is an excellent illustration of *how a SearXNG

instance is build up* (see :ref:`architecture uWSGI`).  If you do not have any

instance is build up* (see :ref:`architecture uWSGI`).  If you do not have any

special preferences, its recommend to use the :ref:`installation docker` or the

special preferences, it's recommended to use the :ref:`installation docker` or the

:ref:`installation scripts`.

:ref:`installation scripts`.





.. attention::

.. attention::