From 1918fb2ea0c17de8d48aa24419b0718b8e86a6dd Mon Sep 17 00:00:00 2001 From: spalinger Date: Thu, 20 Apr 2023 03:39:03 +0200 Subject: [PATCH] [fix] typos/grammar in docs --- docs/admin/buildhosts.rst | 6 +++--- docs/admin/installation-docker.rst | 2 +- docs/admin/installation-scripts.rst | 4 ++-- docs/admin/installation.rst | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index 6926469ef..d4d5ecb91 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -14,7 +14,7 @@ Buildhosts :local: :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`).:: 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 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 -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 as images (``sphinx.ext.imgmath`` extension). @@ -128,7 +128,7 @@ Lint shell scripts .. _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 diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index 1457d6a6b..eb52c5828 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -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. -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: .. code:: sh diff --git a/docs/admin/installation-scripts.rst b/docs/admin/installation-scripts.rst index e256a2461..2d43f5e37 100644 --- a/docs/admin/installation-scripts.rst +++ b/docs/admin/installation-scripts.rst @@ -42,7 +42,7 @@ including a :ref:`uWSGI setup ` as described in the 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 ``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``! .. sidebar:: further read @@ -52,7 +52,7 @@ including a :ref:`uWSGI setup ` as described in the .. _caddy: https://hub.docker.com/_/caddy 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. We use caddy in our :ref:`docker image ` and we have diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index cae51be63..54d901f76 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -12,7 +12,7 @@ Installation 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 -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`. .. attention::