Merge pull request #1985 from ThomasWaldmann/typos-grammar-docs

docs: fix typos and grammar

Author: UlrichB22

CONTRIBUTING.md

@@ -2,16 +2,16 @@
 
 Thank you for your interest in contributing to MoinMoin! We welcome contributions
 and appreciate your support in improving this project. This guide outlines how
-you can contribute, whether through bug reports, code contributions or help with
+you can contribute, whether through bug reports, code contributions, or help with
 documentation.
 
 
-## How to contribute
+## How to Contribute
 
-Find out how you can start reporting bugs, fixing bugs, adding new features or
+Find out how you can start reporting bugs, fixing bugs, adding new features, or
 improving the documentation.
 
-### Reporting bugs
+### Reporting Bugs
 
 If you've encountered a bug, please report it by following these steps:
 
@@ -20,21 +20,21 @@ If you've encountered a bug, please report it by following these steps:
  3. Provide as much detail as possible, including:
   - A description of the bug
   - Steps to reproduce the issue
-  - Any relevant logs or error messages
+  - Any relevant logs or error messages.
 
-### Suggesting enhancements
+### Suggesting Enhancements
 
 If you have an idea for a new feature or improvement:
 
  1. Check the issue tracker to see if the enhancement has already been suggested.
  2. Open a new issue with a detailed description of the suggested enhancement.
  3. Include a rough idea of how the enhancement could be implemented if possible.
 
-### Submitting code or documentation enhancements
+### Submitting Code or Documentation Enhancements
 
 To submit code or documentation updates, follow these steps:
 
- * Setup your development environment, see next chapter.
+ * Set up your development environment; see the next chapter.
  * Create a new branch for your changes:
    ```
    git checkout -b feature-branch
@@ -51,17 +51,17 @@ To submit code or documentation updates, follow these steps:
 We encourage you to split complex changes into smaller, focused pull requests.
 This makes it easier to review and merge your contributions.
 
-## Development setup
+## Development Setup
 
 To begin contributing, you need to set up your development environment. Follow
 the steps below to get started:
 
- * Fork the main moin repository from GitHub
- * Clone your repo to your local development system
- * Create a virtualenv and download Python packages
- * Activate the virtualenv
- * Create a wiki instance with help data and a welcome page
- * Start the built-in server
+ * Fork the main Moin repository on GitHub.
+ * Clone your fork (repository) to your local development system.
+ * Create a virtual environment and install the required Python packages.
+ * Activate the virtual environment.
+ * Create a wiki instance with help data and a welcome page.
+ * Start the built-in server.
 
 For details on setting up your environment, please refer to the MoinMoin
 development documentation at
@@ -70,8 +70,8 @@ development documentation at
 
 ## Code Style and Best Practices
 
-MoinMoin follows some common coding standards to ensure the consistency of the
-code base. Here are some major things to keep in mind:
+MoinMoin follows common coding standards to ensure the consistency of the
+codebase. Here are some major things to keep in mind:
 
  * Python Version: MoinMoin is based on Python 3. Make sure your changes work
    with the versions specified in pyproject.toml.
@@ -81,8 +81,8 @@ code base. Here are some major things to keep in mind:
  * Documentation: Ensure that your changes are well-documented. Add docstrings
    to your functions and classes where appropriate.
 
-We have added Git pre-commit hooks to ensure a consistent code quality.
-The checks include the use of the tools black, ruff and bandit. For details please see
+We use Git pre-commit hooks to help ensure consistent code quality.
+The checks include the tools Black, Ruff, and Bandit. For details, please see
 [moin-20.readthedocs.io](https://moin-20.readthedocs.io/en/latest/devel/development.html#install-pre-commit-hooks)
 
 

README.md

@@ -1,53 +1,53 @@
-MoinMoin - a lightweight open source wiki engine
+MoinMoin — a lightweight open-source wiki engine
 ================================================
 
 <img src="https://github.com/moinwiki/moin/blob/master/src/moin/static/logos/moinmoin.svg?raw=true" alt="MoinMoin Logo" width="120" align="right">
 
-MoinMoin is an easy to use, full-featured and extensible wiki software package
+MoinMoin is an easy-to-use, full-featured, and extensible wiki software package
 written in Python. You can run it on all common operating systems (Windows,
 macOS, Linux, etc.).
 
 This wiki software can fulfill a wide range of roles, such as a personal notes
 organizer deployed on a laptop or home web server, a company knowledge base
 deployed on an intranet, or an Internet server open to individuals sharing the
-same interests, goals or projects.
+same interests, goals, or projects.
 
 
 Documentation and Support
 =========================
 
 > [!NOTE]
-    moin2 is not released yet.
+> Moin2 is not released yet.
 
-You will find the latest docs at https://moin-20.readthedocs.io/en/latest.
+You will find the latest documentation at https://moin-20.readthedocs.io/en/latest.
 
-There is a wiki page collecting all moin2 specific information, links to
-support resources and info about MoinMoin development status and plans:
+There is a wiki page collecting all Moin2-specific information, links to
+support resources, and information about MoinMoin’s development status and plans:
 https://moinmo.in/MoinMoin2.0
 
-In general, you should make sure that the documentation you are reading
-is written for the moin version you are using. Much of the information
-you find in the wiki refers to moin 1.9 and does not apply to moin2.
+In general, ensure that the documentation you are reading
+is written for the Moin version you are using. Much of the information
+you find in the wiki refers to Moin 1.9 and does not apply to Moin2.
 
-For support, please try the documentation, the homepage, the irc channel,
-the mailing lists and the github issues before contacting the MoinMoin
+For support, please try the documentation, the home page, the IRC channel,
+the mailing lists, and GitHub issues before contacting the MoinMoin
 authors directly.
 
 If you have trouble with any web server configuration, please try reading
-the web server's documentation. Same thing applies for any other 3rd party
-software usually used with moin, but not written by the MoinMoin developers.
+the web server's documentation. The same applies to any other third-party
+software commonly used with Moin but not written by the MoinMoin developers.
 
 
 Contributing
 ============
 
 You're welcome to help us make MoinMoin even better! Whether you have experience
-with Python, HTML or CSS or are just starting out, there are many ways you
-can contribute - please see [CONTRIBUTING](https://github.com/moinwiki/moin/blob/master/CONTRIBUTING.md).
+with Python, HTML, or CSS, or are just starting out, there are many ways you
+can contribute — please see [CONTRIBUTING](https://github.com/moinwiki/moin/blob/master/CONTRIBUTING.md).
 
 
-Acknowledgements
+Acknowledgments
 ================
 
-We have to thank a lot of people for their valuable ideas, time and
-contributions - please see [contributors](https://github.com/moinwiki/moin/graphs/contributors).
+We thank the many people who have contributed their valuable ideas, time, and
+code — please see the [contributors](https://github.com/moinwiki/moin/graphs/contributors) page.

SECURITY.md

@@ -8,7 +8,7 @@
 
 ## Reporting a Vulnerability
 
-Please report vulnerabilities privately via Github:
+Please report vulnerabilities privately via GitHub:
 
 https://github.com/moinwiki/moin/security
 

docs/admin/backup.rst

@@ -8,37 +8,36 @@ Full Backup / Restore
 The best way to recover from data loss is to have a **full** backup of your machine.
 With this backup you can easily restore your machine to a working condition.
 
-The procedure below explains how to selectively backup only the files
+The procedure below explains how to selectively back up only the files
 essential to your MoinMoin installation. While there is no need to maintain both a full
 and a selective backup, having at least one of the two is strongly recommended.
 
 Selective Backup
 ================
-If you want a backup of MoinMoin and your data, then backup the following:
+If you want a backup of MoinMoin and your data, then back up the following:
 
 * your data, usually everything under wiki/
-* moin configuration, e.g. wikiconfig.py
-* logging configuration, e.g. logging.conf
-* moin deployment script, e.g. moin.wsgi
-* web server configuration, e.g. apache virtualhost config
-* optional: moin code + dependencies; you should at least know which version
+* Moin configuration, e.g., wikiconfig.py
+* logging configuration, e.g., logging.conf
+* Moin deployment script, e.g., moin.wsgi
+* web server configuration, e.g., Apache VirtualHost config
+* optional: Moin code + dependencies; you should at least know which version
   you ran, so you can reinstall that version when you need to restore
 
-To create a dump of all data stored in moinmoin (wiki items, user profiles), run the
+To create a dump of all data stored in MoinMoin (wiki items, user profiles), run the
 following command::
 
  moin save --all-backends --file backup.moin
 
-Please note that this file contains sensitive data like user profiles, wiki
+Please note that this file contains sensitive data like user profiles and wiki
 contents, so store your backups in a safe place that no unauthorized
 individual can access.
 
-Backups require valid metadata to produce files which can be loaded
+Backups require valid metadata to produce files that can be loaded;
 in particular, the size attribute must be correct for each revision.
-if bad metadata is found during the backup,
-there will be a warning logged and it is recommended
-to run ``moin validate-metadata -a -f``
-see :ref:`validate-metadata`
+If bad metadata is found during the backup, a warning will be logged and it is recommended
+to run ``moin maint-validate-metadata --all-backends --fix``.
+See :ref:`validate-metadata`.
 
 Selective Restore
 =================

docs/admin/changes.rst

@@ -1,4 +1,3 @@
-:tocdepth: 2
 
 .. _changes:
 

docs/admin/configure.rst

@@ -3,7 +3,7 @@ Introduction into MoinMoin Configuration
 ========================================
 Kinds of configuration files
 ============================
-To change how moinmoin behaves and looks, you may customize it by editing
+To change how MoinMoin behaves and looks, you may customize it by editing
 its configuration files:
 
 * Wiki Engine Configuration
@@ -21,7 +21,7 @@ its configuration files:
 
 * Logging Configuration
 
-  - optional; if you don't configure this, it will use the builtin defaults
+  - optional; if you don't configure this, it will use the built-in defaults
   - this is a separate file, often called logging.conf
   - it has an .ini-like file format
 
@@ -70,11 +70,11 @@ The directories and files shown are referenced in this section of documentation
         wiki/                 # the wiki instance; created by running "./m new-wiki" or "moin create-instance" commands
             data/             # wiki data and metadata
             index/            # wiki indexes
-        wiki_local/           # a convenient location to store custom CSS, Javascript, templates, logos, etc.
+        wiki_local/           # a convenient location to store custom CSS, JavaScript, templates, logos, etc.
         wikiconfig.py         # main configuration file, modify this to add or change features
         intermap.txt          # interwiki map: copied by quickinstall.py, updated by "./m interwiki"
 
-After installing moin from pypi or unpacking using a package manager, the directory structure will
+After installing Moin from PyPI or unpacking using a package manager, the directory structure will
 look like this::
 
     myvenv/                 # virtualenv root
@@ -93,8 +93,8 @@ and execute `moin run`.::
             data/           # wiki data and metadata
             index/          # wiki indexes
             preview/        # text item backups are created when user clicks edit Preview button
-            sql/            # sqlite database used for edit locking
-        wiki_local/         # store custom CSS, Javascript, templates, logos, etc. here
+            sql/            # SQLite database used for edit locking
+        wiki_local/         # store custom CSS, JavaScript, templates, logos, etc. here
         wikiconfig.py       # main configuration file, modify this to add or change features
         intermap.txt        # list of external wikis used in wikilinks: [[MeatBall:InterWiki]]
 
@@ -270,7 +270,7 @@ Adding scripts
 ~~~~~~~~~~~~~~
 You can add scripts like this::
 
-    {# Additional Javascript #}
+    {# Additional JavaScript #}
     {% macro scripts() -%}
     <script type="text/javascript" src="{{ url_for('serve.files', name='wiki_local', filename='MyScript.js') }}"></script>
     {% endmacro %}
@@ -401,7 +401,7 @@ That way they are easily usable on all operating systems, whether it has a packa
 system or not.
 
 In many cases, those external static files are maintained by someone else (like jQuery
-javascript library or larger js libraries) and we definitely do not want to merge
+JavaScript library or larger JS libraries) and we definitely do not want to merge
 them into our project.
 
 For MoinMoin we require the following XStatic Packages in pyproject.toml:
@@ -426,7 +426,7 @@ For MoinMoin we require the following XStatic Packages in pyproject.toml:
   used by basic theme to adjust textarea on modify view.
 
 * `svgedit_moin <https://pypi.org/project/XStatic-svg-edit-moin>`_
-  is loaded at template modify_svg-edit. It is a fast, web-based, Javascript-driven
+  is loaded at template modify_svg-edit. It is a fast, web-based, JavaScript-driven
   SVG editor.
 
 * `jquery_tablesorter <https://pypi.org/project/XStatic-JQuery.TableSorter/2.14.5.1>`_
@@ -723,7 +723,7 @@ Password strength
 As you might know, many users are bad at choosing reasonable passwords and some
 are tempted to use easily crackable passwords.
 
-To help users choose reasonable passwords, moin has a simple builtin
+To help users choose reasonable passwords, Moin has a simple built-in
 password checker that is enabled by default and does some sanity checks,
 so users don't choose easily crackable passwords.
 
@@ -1305,7 +1305,7 @@ Features:
 * uses slqalchemy (without the ORM) for database abstraction
 * supports multiple types of databases, for example:
 
-  - sqlite (default, comes built-into Python)
+  - SQLite (default, comes built into Python)
   - postgresql
   - mysql
   - and others, see sqlalchemy docs.
@@ -1326,12 +1326,12 @@ Please see the sqlalchemy docs about the DBURI part.
 Grant 'myuser' (his password: 'mypassword') full access to these databases.
 
 
-sqlite store
+SQLite store
 ------------
 Features:
 
-* directly talks to sqlite, without using sqlalchemy
-* stores data into an sqlite database, which is a single file
+* directly talks to SQLite, without using SQLAlchemy
+* stores data into a SQLite database, which is a single file
 * can either use 1 database per store or 1 table per store and you need to
   give different table names then
 * can optionally compress/decompress the data using zlib: default compression
@@ -1343,11 +1343,11 @@ Features:
     stores:sqlite:/srv/mywiki/data/mywiki_%(nsname)s.db::%(kind)s
     stores:sqlite:/srv/mywiki/data/mywiki_%(nsname)s.db::%(kind)s::1
 
-The uri part after "sqlite:" is like::
+The URI part after "sqlite:" is like::
 
     PATH::TABLENAME::COMPRESSION
 
-It uses "::" as separator to support windows pathes which may have ":" after
+It uses "::" as a separator to support Windows paths, which may have ":" after
 the drive letter.
 
 
@@ -1471,15 +1471,15 @@ to convert a moin 1.9 wiki to moin 2.0, then an item `foo` would be renamed to `
 Mail configuration
 ==================
 
-Sending E-Mail
+Sending Email
 --------------
-Moin can optionally send E-Mail. Possible uses:
+Moin can optionally send email. Possible uses:
 
 * send out item change notifications
 * enable users to reset forgotten passwords
 * inform admins about runtime exceptions
 
-You need to configure some settings before sending E-Mail can be supported::
+You need to configure some settings before sending email can be supported::
 
     # the "from:" address [Unicode]
     mail_from = "wiki <[email protected]>"
@@ -1500,7 +1500,7 @@ You need to configure some settings before sending E-Mail can be supported::
 
    describe more moin configuration
 
-Admin Traceback E-Mails
+Admin Traceback Emails
 -----------------------
 If you want to enable admins to receive Python tracebacks, you need to configure
 the following::
@@ -1514,13 +1514,13 @@ the following::
 
 Please also check the logging configuration example in `contrib/logging/email`.
 
-User E-Mail Address Verification
+User Email Address Verification
 --------------------------------
 
-At account creation time, Moin can require new users to verify their E-Mail
+At account creation time, Moin can require new users to verify their email
 address by clicking a link that is sent to them.
 
-Make sure that Moin is able to send E-Mails (see previous section) and add the
+Make sure that Moin is able to send emails (see previous section) and add the
 following line to your configuration file to enable this feature::
 
     user_email_verification = True