From f175574f3731c99d82758952e37f52037476aa5f Mon Sep 17 00:00:00 2001 From: ToxyFlog1627 <59206807+ToxyFlog1627@users.noreply.github.com> Date: Fri, 11 Aug 2023 14:01:54 +0000 Subject: [PATCH] [fix] typos in documentation & messages --- .github/workflows/translations-update.yml | 2 +- docs/admin/buildhosts.rst | 2 +- docs/admin/installation-docker.rst | 4 ++-- docs/admin/installation-searxng.rst | 2 +- docs/admin/settings/settings_redis.rst | 2 +- docs/admin/settings/settings_ui.rst | 2 +- docs/admin/update-searxng.rst | 2 +- docs/dev/contribution_guide.rst | 2 +- docs/dev/engines/index.rst | 2 +- docs/dev/engines/online/duckduckgo.rst | 6 +++--- docs/dev/lxcdev.rst | 6 +++--- docs/dev/makefile.rst | 4 ++-- docs/dev/quickstart.rst | 6 +++--- docs/dev/translation.rst | 2 +- docs/utils/lxc.sh.rst | 4 ++-- searx/settings.yml | 2 +- searx/version.py | 2 +- utils/lib_sxng_static.sh | 4 ++-- utils/searx.sh | 2 +- 19 files changed, 29 insertions(+), 29 deletions(-) diff --git a/.github/workflows/translations-update.yml b/.github/workflows/translations-update.yml index bf1e11813..769a0b160 100644 --- a/.github/workflows/translations-update.yml +++ b/.github/workflows/translations-update.yml @@ -6,7 +6,7 @@ on: jobs: babel: - name: "create PR for additons from weblate" + name: "create PR for additions from weblate" runs-on: ubuntu-20.04 if: ${{ github.repository_owner == 'searxng' && github.ref == 'refs/heads/master' }} steps: diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index b7f317f74..bdb9ae1d4 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -33,7 +33,7 @@ This will install packages needed by SearXNG: :start-after: START distro-packages :end-before: END distro-packages -and packages needed to build docuemtation and run tests: +and packages needed to build documentation and run tests: .. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START build-packages diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index eb52c5828..c667c4f44 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -43,7 +43,7 @@ of this container: - enables :ref:`limiter ` to protect against bots - enables :ref:`image proxy ` for better privacy -- enables :ref:`cache busting ` to save bandwith +- enables :ref:`cache busting ` to save bandwidth ---- @@ -108,7 +108,7 @@ can modify these files according to your needs and restart the Docker image. Use command ``container ls`` to list running containers, add flag `-a `__ to list exited containers also. With ``container stop`` a running container can be -stoped. To get rid of a container use ``container rm``: +stopped. To get rid of a container use ``container rm``: .. code:: sh diff --git a/docs/admin/installation-searxng.rst b/docs/admin/installation-searxng.rst index 3efc48e8c..7bb936f15 100644 --- a/docs/admin/installation-searxng.rst +++ b/docs/admin/installation-searxng.rst @@ -86,7 +86,7 @@ below. This setup: - enables :ref:`limiter ` to protect against bots - enables :ref:`image proxy ` for better privacy -- enables :ref:`cache busting ` to save bandwith +- enables :ref:`cache busting ` to save bandwidth Modify the ``/etc/searxng/settings.yml`` to your needs: diff --git a/docs/admin/settings/settings_redis.rst b/docs/admin/settings/settings_redis.rst index df5dc743f..9fb067553 100644 --- a/docs/admin/settings/settings_redis.rst +++ b/docs/admin/settings/settings_redis.rst @@ -7,7 +7,7 @@ .. _Redis.from_url(url): https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url A redis DB can be connected by an URL, in :py:obj:`searx.redisdb` you -will find a description to test your redis connection in SerXNG. When using +will find a description to test your redis connection in SearXNG. When using sockets, don't forget to check the access rights on the socket:: ls -la /usr/local/searxng-redis/run/redis.sock diff --git a/docs/admin/settings/settings_ui.rst b/docs/admin/settings/settings_ui.rst index e355199a2..8f390e58d 100644 --- a/docs/admin/settings/settings_ui.rst +++ b/docs/admin/settings/settings_ui.rst @@ -46,7 +46,7 @@ .. cache_url: ``cache_url`` : ``https://web.archive.org/web/`` - URL prefix of the internet archive or cache, don't forgett trailing slash (if + URL prefix of the internet archive or cache, don't forget trailing slash (if needed). The default is https://web.archive.org/web/ alternatives are: - https://webcache.googleusercontent.com/search?q=cache: diff --git a/docs/admin/update-searxng.rst b/docs/admin/update-searxng.rst index 27c0108d4..b9d15c3f7 100644 --- a/docs/admin/update-searxng.rst +++ b/docs/admin/update-searxng.rst @@ -61,7 +61,7 @@ and then, to name just a few: - The image proxy morty is no longer needed, it has been replaced by the :ref:`image proxy ` from SearXNG. -- To save bandwith :ref:`cache busting ` has been implemented. +- To save bandwidth :ref:`cache busting ` has been implemented. To get in use, the ``static-expires`` needs to be set in the :ref:`uwsgi setup`. diff --git a/docs/dev/contribution_guide.rst b/docs/dev/contribution_guide.rst index bc4f6514d..df5200637 100644 --- a/docs/dev/contribution_guide.rst +++ b/docs/dev/contribution_guide.rst @@ -186,5 +186,5 @@ commit and push: .. attention:: - If you are working in your own brand, don't forgett to adjust your + If you are working in your own brand, don't forget to adjust your :ref:`settings brand`. diff --git a/docs/dev/engines/index.rst b/docs/dev/engines/index.rst index b5c3184e0..88dd874d3 100644 --- a/docs/dev/engines/index.rst +++ b/docs/dev/engines/index.rst @@ -26,7 +26,7 @@ The :py:obj:`engine_type ` of an engine determines which :ref:`search processor ` is used by the engine. -In this section a list of the enignes that are documented is given, a complete +In this section a list of the engines that are documented is given, a complete list of the engines can be found in the source under: :origin:`searx/engines`. .. _online engines: diff --git a/docs/dev/engines/online/duckduckgo.rst b/docs/dev/engines/online/duckduckgo.rst index d0d18eb8a..a73b38983 100644 --- a/docs/dev/engines/online/duckduckgo.rst +++ b/docs/dev/engines/online/duckduckgo.rst @@ -1,8 +1,8 @@ .. _duckduckgo engines: -================= -DukcDukGo Engines -================= +================== +DuckDuckGo Engines +================== .. contents:: :depth: 2 diff --git a/docs/dev/lxcdev.rst b/docs/dev/lxcdev.rst index 854b193ff..79716ae57 100644 --- a/docs/dev/lxcdev.rst +++ b/docs/dev/lxcdev.rst @@ -148,7 +148,7 @@ services quite easy. In the example above the SearXNG instance in the container is wrapped to ``http://n.n.n.140/searxng`` to the HOST system. Note, on your HOST system, the IP of your ``searxng-archlinux`` container is different to this example. To -test the instance in the conatiner from outside of the container, in your WEB +test the instance in the container from outside of the container, in your WEB browser on your desktop just open the URL reported in your installation .. _working in containers: @@ -255,7 +255,7 @@ With the use of the :ref:`searxng.sh` the SearXNG service was installed as With the command above, we stopped the SearXNG uWSGI-App in the archlinux container. -The uWSGI-App for the archlinux dsitros is configured in +The uWSGI-App for the archlinux distros is configured in :origin:`utils/templates/etc/uwsgi/apps-archlinux/searxng.ini`, from where at least you should attend the settings of ``uid``, ``chdir``, ``env`` and ``http``:: @@ -272,7 +272,7 @@ shares the root folder of the repository and the command ``utils/lxc.sh cmd`` handles relative path names **transparent**. To wrap the SearXNG installation in the container into a developer one, we -simple have to create a smylink to the **transparent** reposetory from the +simple have to create a symlink to the **transparent** repository from the desktop. Now lets replace the repository at ``searxng-src`` in the container with the working tree from outside of the container: diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 62ac2e905..286055afb 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -138,7 +138,7 @@ from the YAML configuration: - ``SEARXNG_PORT`` from :ref:`server.port ` The ``GIT_URL`` and ``GIT_BRANCH`` in the origin:`utils/brand.env` file, are -readed from the git VCS and the branch that is checked out when ``make +read from the git VCS and the branch that is checked out when ``make buildenv`` command runs. .. _brand: @@ -423,7 +423,7 @@ To get live builds while modifying CSS & JS use (:ref:`make run`): The :origin:`Makefile` targets ``static.build.*`` cover common tasks to build (a commit of) the static files. The ``./manage static.build..*`` command line -can be used to convenient run common build tasks of the satic files. +can be used to convenient run common build tasks of the static files. .. program-output:: bash -c "cd ..; ./manage static.help" diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index 9bee8f60c..c45c24491 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -67,14 +67,14 @@ the modified source code from the build products first run: make static.build.restore This will restore the old build products and only your changes of the code -remain in the working tree which can now be added & commited. When all sources -are commited, you can commit the build products simply by: +remain in the working tree which can now be added & committed. When all sources +are committed, you can commit the build products simply by: .. code:: bash make static.build.commit -Commiting the build products should be the last step, just before you send us +Committing the build products should be the last step, just before you send us your PR. There is also a make target to rewind this last build commit: .. code:: bash diff --git a/docs/dev/translation.rst b/docs/dev/translation.rst index 693f6d2da..57c76a0c1 100644 --- a/docs/dev/translation.rst +++ b/docs/dev/translation.rst @@ -56,7 +56,7 @@ Sync from *origin* to *weblate*: using ``make weblate.push.translations`` <.github/workflows/integration.yml>` checks for updated translations. Sync from *weblate* to *origin*: using ``make weblate.translations.commit`` - Every Friday, the GitHub workflow :origin:`babel / create PR for additons from + Every Friday, the GitHub workflow :origin:`babel / create PR for additions from weblate <.github/workflows/translations-update.yml>` creates a PR with the updated translation files: diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index 43dc915ef..88b0b4a9d 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -175,7 +175,7 @@ Each container shares the root folder of the repository and the command /share/SearXNG The path ``/share/SearXNG`` will be different on your HOST system. The commands -in the conatiner are executed by the ``root`` inside of the container. Compare +in the container are executed by the ``root`` inside of the container. Compare output of:: $ ls -li Makefile @@ -190,7 +190,7 @@ Since the path ``/share/SearXNG`` of the HOST system is wrapped into the container under the same name, the shown ``Makefile`` (inode ``47712402``) in the ouput is always the identical ``/share/SearXNG/Makefile`` from the HOST system. In the example shown above the owner of the path in the container is -the ``root`` user of the conatiner (and the timezone in the container is +the ``root`` user of the container (and the timezone in the container is different to HOST system). diff --git a/searx/settings.yml b/searx/settings.yml index d7d5d2c48..f45cca808 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -113,7 +113,7 @@ ui: default_theme: simple # center the results ? center_alignment: false - # URL prefix of the internet archive, don't forgett trailing slash (if needed). + # URL prefix of the internet archive, don't forget trailing slash (if needed). # cache_url: "https://webcache.googleusercontent.com/search?q=cache:" # Default interface locale - leave blank to detect from browser information or # use codes from the 'locales' config section diff --git a/searx/version.py b/searx/version.py index 7a368e366..2931b6af4 100644 --- a/searx/version.py +++ b/searx/version.py @@ -65,7 +65,7 @@ def get_git_version(): git_commit_date_hash = git_commit_date_hash.replace('.0', '.') tag_version = git_version = git_commit_date_hash - # add "+dirty" suffix if there are uncommited changes except searx/settings.yml + # add "+dirty" suffix if there are uncommitted changes except searx/settings.yml try: subprocess_run("git diff --quiet -- . ':!searx/settings.yml' ':!utils/brand.env'") except subprocess.CalledProcessError as e: diff --git a/utils/lib_sxng_static.sh b/utils/lib_sxng_static.sh index 1d76bfe70..de34ea629 100755 --- a/utils/lib_sxng_static.sh +++ b/utils/lib_sxng_static.sh @@ -82,9 +82,9 @@ static.build.commit() { build_msg STATIC "build & commit /static files" - # check for not commited files + # check for not committed files if [ -n "$(git diff --name-only)" ]; then - err_msg "some files are not commited:" + err_msg "some files are not committed:" git diff --name-only | prefix_stdout " " return 1 fi diff --git a/utils/searx.sh b/utils/searx.sh index 5473c11c4..719cd2031 100755 --- a/utils/searx.sh +++ b/utils/searx.sh @@ -67,7 +67,7 @@ installations that were installed with this script." remove_settings wait_key if service_is_available "${PUBLIC_URL}"; then - MSG="** Don't forgett to remove your public site! (${PUBLIC_URL}) **" wait_key 10 + MSG="** Don't forget to remove your public site! (${PUBLIC_URL}) **" wait_key 10 fi }