docs: fixed some typos

Author: thorsten

docs/administration.md

@@ -103,7 +103,7 @@ time with all the relevant data of the specific entry. The meaning of the fields
 - **Language**
   You can select the language of your FAQ. By default, the selected language saved in the configuration will be chosen.
   You can create entries in multiple languages like this: Write an article in English (or any other language) and save
-  it. Now choose _Edit FAQs_ and edit your English FAQ record. Change the question, answer and keywords and change
+  it. Now choose _Edit FAQs_ and edit your English FAQ record. Change the question, answer, and keywords and change
   language to, let's say Brazilian Portuguese. _Save_ the FAQ record. Now you can, when you click _edit records_, see
   both FAQs in your list, having the same id, yet different languages.
 
@@ -114,7 +114,7 @@ time with all the relevant data of the specific entry. The meaning of the fields
 
 - **Keywords**
   Keywords are relevant for searching through the database. In case you didn't include a specific word in the FAQ
-  itself, but it is closely related to the content you may wish to include it as a keyword, so the FAQ will come up as
+  itself, but it is closely related to the content, you may wish to include it as a keyword, so the FAQ will come up as
   a search result. It is also possible to use non-related keywords so that a wrongly entered search will also lead to
   the right results.
 
@@ -128,7 +128,7 @@ time with all the relevant data of the specific entry. The meaning of the fields
   It is possible to specify the author's email for your FAQ, but the email address won't be shown in the frontend.
 
 - **Solution ID**
-  Every FAQ generates automatically a so-called solution ID. All records can be accessed directly by putting this ID
+  Every FAQ automatically generates a so-called solution ID. All records can be accessed directly by putting this ID
   into the search box.
 
 - **Active?**
@@ -172,7 +172,7 @@ You can edit and delete all records as well. Please note that old revisions won'
 deleted.
 
 phpMyFAQ lets visitors contribute to the FAQ by asking questions. Every visitor is able to view these open questions in
-the public area, and may give an answer. If you wish to get rid of open questions, you can do so using this section.
+the public area and may give an answer. If you wish to get rid of open questions, you can do so using this section.
 Alternatively, you can take over a question and answer it yourself and hereby add it to the FAQ.
 
 ### 5.2.3 Sticky FAQs
@@ -218,8 +218,8 @@ You can edit existing tags, and if you need to, you can delete the tag.
 
 Below every FAQ, a visitor has the chance to rate the overall quality of a FAQ by giving ratings from one to five
 (whereas 1 is the worst, 5 the best rating).
-In the statistics, the average rating and number of votes becomes visible for every rated FAQ.
-To give you a quick overview, FAQs with an average rating of two or worse are displayed in red, an average
+In the statistics, the average rating and number of votes become visible for every rated FAQ.
+To give you a quick overview, FAQs with an average rating of two or worse are displayed in red; an average
 above 4 results in a green number.
 
 ### 5.3.2 View sessions
@@ -270,7 +270,7 @@ You can export your contents of your whole FAQ or just some selected categories
 ### 5.4.3 Batch upload via phpMyAdmin
 
 > [!NOTE]
-> You should have a table ready with the data you want to import. The titles of your new FAQ's in one column, the HTML-formatted content in the next and the keywords in a third column.
+> You should have a table ready with the data you want to import. The titles of your new FAQ's in one column, the HTML-formatted content in the next, and the keywords in a third column.
 >
 > You should have access to phpMyAdmin via your web host.
 >
@@ -309,7 +309,7 @@ Save all 5 CSV-Files in a separate folder on your computer. Then you can close p
 #### 5.4.3.2 Edit the tables
 
 Open the first CSV file _faqdata.csv_ with the spreadsheet program of your choice.
-(You can use LibreOffice, OpenOffice or Excel, for example.)
+(You can use LibreOffice, OpenOffice, or Excel, for example.)
 Look at the table BEFORE you make any changes.
 Pay attention to the column headings and the contents of the individual fields.
 DO NOT change the column headings.
@@ -367,9 +367,9 @@ So we open phpMyAdmin again.
 Select the correct table on the left.
 Click on Import at the top.
 Select the correct one of our 4 CSV tables out of your folder.
-For Skip number of queries, select 1 so that our column headings are not created as a post.
+To Skip the number of queries, select 1 so that our column headings are not created as a post.
 The format must be CSV.
-Check also **update data when duplicate keys found on import**.
+Check also **update data when duplicate keys are found on import**.
 Otherwise, changes to existing entries won't be saved.
 Else everything should be fine.
 Now click on Import.
@@ -389,7 +389,7 @@ regular backups of your FAQ.
 - **backup data**
   A backup of all **data** will include all entries, users, comments, etc.
 - **backup logs**
-  The sessions of visits and the admin log will be saved (i.e. all **log** files). This information is not necessary
+  The sessions of visits and the admin log will be saved (i.e., all **log** files). This information is not necessary
   for running phpMyFAQ, they serve only statistical purposes.
 
 During the backup process, phpMyFAQ generates a hash on the whole backup file and stores this information. The hashes
@@ -434,7 +434,7 @@ For example, if you want to use _faq.example.org_ and _beta.faq.example.org_, it
 ### 5.6.3 Stop Words configuration
 
 We need stop words for the smart answering feature and the related answers. If a user is adding a new question to your
-FAQ the words will be checked against all FAQs in your database but without the stop words. Stop words are words with a
+FAQ, the words will be checked against all FAQs in your database but without the stop words. Stop words are words with a
 very low relevance like the English word _the_.
 
 ### 5.6.4 phpMyFAQ Update (Experimental feature)

docs/deployment.md

@@ -63,7 +63,7 @@ This guide explains how to deploy phpMyFAQ in production using Docker Compose wi
    - Go to **Stacks** → **Add stack**
    - Give it a name: `phpmyfaq`
 
-3. **Upload or paste the compose file**
+3. **Upload or paste the docker-compose file**
    - **Option A**: Use the Web editor
      - Paste the contents of `docker-compose.prod.yml`
 
@@ -98,14 +98,14 @@ This guide explains how to deploy phpMyFAQ in production using Docker Compose wi
 
 7. **Verify deployment**
    - Go to **Containers** to see running services
-   - Check health status of each container
+   - Check the health status of each container
    - Access the application at the configured port
 
 ### Method 2: Using Portainer Custom Templates
 
 1. **Create a Custom Template**
    - Go to **App Templates** → **Custom Templates**
-   - Create new template
+   - Create a new template
    - Name: `phpMyFAQ Production`
    - Platform: `Linux`
    - Type: `Stack`

docs/index.md

@@ -25,7 +25,7 @@ This documentation serves as a guide to help you install, update, use, and admin
 ### Copyright
 
 phpMyFAQ is published under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/2.0/) (MPL).
-This license guarantees you the free usage of phpMyFAQ, access to the source code and the right to modify and distribute
+This license guarantees you the free usage of phpMyFAQ, access to the source code, and the right to modify and distribute
 phpMyFAQ.
 
 The only restrictions apply to the copyright, which remains at all times at Thorsten Rinne and the phpMyFAQ Team. Any
@@ -35,7 +35,7 @@ certain functions of phpMyFAQ is not affected by these restrictions and may be d
 A commercial usage or commercial distribution of phpMyFAQ is allowed, as long as the conditions mentioned above are
 met.
 
-We decided to use MPL as the licensing model for phpMyFAQ because we feel that it is a good compromise between the
+We decided to use MPL as the licensing model for phpMyFAQ. We feel that it is a good compromise between the
 protection of the openness and free distribution on the one hand and the interaction with other software regardless of
 its licensing model. When compared to other licensing models, its text is short and easily comprehensible, even for
 newcomers.

docs/installation.md

@@ -85,7 +85,7 @@ phpMyFAQ uses a modern HTML5/CSS3 powered markup. The supported browsers are the
 (Windows/macOS/Linux), the latest Safari (macOS/iOS), the latest Chrome (Windows/macOS/Linux), the latest Opera
 (Windows/macOS/Linux) and Microsoft Edge (Windows/macOS/Linux).
 
-We recommend using the latest version of Firefox, Chrome, Safari, Opera or Microsoft Edge.
+We recommend using the latest version of Firefox, Chrome, Safari, Opera, or Microsoft Edge.
 
 ## 2.2 Preparations
 
@@ -125,7 +125,7 @@ All other directories shouldn't be world-writable for your own security.
 
 **Note**: If you're running SELinux, you may need further configuration, or you should completely disable it.
 
-The database user needs the permissions for CREATE, DROP, ALTER, INDEX, INSERT, UPDATE, DELETE and SELECT on all tables
+The database user needs the permissions for CREATE, DROP, ALTER, INDEX, INSERT, UPDATE, DELETE, and SELECT on all tables
 in the database.
 
 ### 2.2.2 Cloud Hosting via Docker
@@ -198,7 +198,7 @@ You have to add at least one Elasticsearch or OpenSearch node and the index name
 ### Step 4: Admin user setup
 
 In addition, you can enter your language, the default here is English.
-Furthermore, you should register your name, your email address and - very importantly - your password.
+Furthermore, you should register your name, your email address, and - very importantly - your password.
 You must enter the password twice, and it has to be at least eight characters long.
 Then click the button **"install"** to initialize the tables in your database.
 
@@ -233,9 +233,9 @@ You can change
 
 ## 2.8 Notes regarding the search functionality
 
-- The boolean full-text search will only work with MySQL and if there are some entries in the database (5 or more).
+- The boolean full-text search will only work with MySQL/MariaDB and if there are some entries in the database (5 or more).
   The term you are looking for should also not be in more than 50% of all your entries, or it will automatically be
-  excluded from search. This is not a bug, but rather a feature of MySQL.
+  excluded from search. This is not a bug, but rather a feature of MySQL/MariaDB.
 - The search on other databases is using the LIKE operator currently.
 - To improve the search functionality, you should consider using Elasticsearch or OpenSearch.
 
@@ -251,15 +251,15 @@ How this is done depends on the browser you are using.
 
 ## 2.10 Enabling LDAP or Microsoft Active Directory support
 
-If you're entered the correct LDAP or Microsoft Active Directory information during the installation, you have to enable
+If you entered the correct LDAP or Microsoft Active Directory information during the installation, you have to enable
 the LDAP or Microsoft Active Directory support in the configuration in the admin backend. Now your user can authenticate
 themselves in phpMyFAQ against your LDAP server or a Microsoft Active Directory server.
 
 If you need special options for your LDAP or ADS configuration, you can change the LDAP configuration in the admin
 configuration panel.
 
-If you want to add LDAP support later, you can use the file **content/core/config/ldap.php.original** as template, and
-if you rename it to **content/core/config/ldap.php** you can use the LDAP features as well after you enabled it in the
+If you want to add LDAP support later, you can use the file **content/core/config/ldap.php.original** as a template. 
+If you rename it to **content/core/config/ldap.php** you can use the LDAP features as well after you enabled it in the
 administration backend.
 
 Please note that you have to use the correct LDAP attributes for your LDAP server. 
@@ -280,9 +280,9 @@ you have to add the following configuration to /etc/ldap/ldap.conf:
 Main features of the PDF export:
 
 - supports all ISO page formats;
-- supports custom page formats, margins and units of measure;
+- supports custom page formats, margins, and units of measure;
 - supports UTF-8 Unicode and Right-To-Left languages;
-- supports TrueTypeUnicode, OpenTypeUnicode, TrueType, OpenType, Type1 and CID-0 fonts;
+- supports TrueTypeUnicode, OpenTypeUnicode, TrueType, OpenType, Type1, and CID-0 fonts;
 - includes methods to publish some HTML code;
 - includes graphic (geometric) and transformation methods;
 - includes methods to set Bookmarks and print a Table of Content;
@@ -318,7 +318,7 @@ support for Google Recaptcha by adding your site and secret key. You can get the
 ## 2.14 Attachments
 
 phpMyFAQ supports encrypted attachments. The encryption uses the [AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard)
-algorithm implemented in mcrypt extension (if available) or with native PHP Rijndael implementation. The key size vary
+algorithm implemented in mcrypt extension (if available) or with native PHP Rijndael implementation. The key size varies
 depending on the implementation used and can be max 256 bits long. Use of mcrypt extension is strongly recommended because
 of performance reasons, its availability is checked automatically at the run time.
 
@@ -327,7 +327,7 @@ Please be aware:
 - Disabling encryption will cause all files to be saved unencrypted.
   In this case, you'll benefit from sparing disk space because identical files are saved only once.
 - Do not change the default attachment encryption key once files were uploaded.
-  Doing so will cause all the previously uploaded files to be wrong decrypted.
+  Doing so will cause all the previously uploaded files to be wrongly decrypted.
   If you need to change the default key, you will have to re-upload all files.
 - Always memorize your encryption keys. There is no way to decrypt files without a correct key.
 - Files are always saved with names based on a virtual hash generated from several tokens (just like key and issue id
@@ -356,7 +356,7 @@ You need a running Elasticsearch instance accessible by phpMyFAQ via HTTP/REST.
 You can add the IP(s)/Domain(s) and port(s) of your Elasticsearch cluster during installation or later by renaming the
 Elasticsearch file located in the folder config/.
 If you choose to add this during installation, the file will be automatically written and the index will be built.
-If you enabled Elasticsearch support in the admin configuration panel, you can create, re-import and delete your
+If you enabled Elasticsearch support in the admin configuration panel, you can create, re-import, and delete your
 index with a user-friendly interface.
 
 ## 2.17 OpenSearch Support
@@ -366,7 +366,7 @@ You need a running OpenSearch instance accessible by phpMyFAQ via HTTP/REST.
 You can add the IP(s)/Domain(s) and port(s) of your OpenSearch cluster during installation or later by renaming the
 OpenSearch file located in the folder config/.
 If you choose to add this during installation, the file will be automatically written and the index will be built.
-If you enabled OpenSearch support in the admin configuration panel, you can create, re-import and delete your
+If you enabled OpenSearch support in the admin configuration panel, you can create, re-import, and delete your
 index with a user-friendly interface.
 
 ## 2.18 SSO (Single Sign-On) Support

docs/update.md

@@ -128,14 +128,14 @@ Click the button of the update script, your version will automatically be update
 If you're running phpMyFAQ 4.0.0 or later, you can use the built-in online update feature.
 Log in as admin into the admin section and enable the maintenance mode.
 (Configuration >> Edit Configuration >> Set FAQ in maintenance mode)
-Then go to the "phpMyFAQ Update" page in the configuration section click through the update wizard:
+Then go to the "phpMyFAQ Update" page in the configuration section and click through the update wizard:
 
 1. Check for System Health: this checks if your system is ready for the upgrade
 2. Check for Updates: this checks if there is a new version of phpMyFAQ available
 3. Download of phpMyFAQ: this downloads the latest version of phpMyFAQ in the background, this can take some seconds
 4. Extracting phpMyFAQ: this extracts the downloaded archive, this can take a while
 5. Install downloaded package: first, it creates a backup of your current installation, then it copies the downloaded
-   files into your installation and in the end, the database is updated
+   files into your installation, and in the end, the database is updated
 
 Note:
 The online update feature is experimental and might not work in all environments.
@@ -148,6 +148,6 @@ You have to compile the SCSS files into CSS using a SCSS compiler with Node.js.
 
 If you need help with theming phpMyFAQ, please don't hesitate to ask in our [forum](https://forum.phpmyfaq.de/).
 
-Note: The character set for all languages and templates is UTF-8. If you notice problems with e.g. German umlauts, you
+Note: The character set for all languages and templates is UTF-8. If you notice problems with e.g., German umlauts, you
 have to convert your templates to UTF-8 encoding. Please use UNIX file endings \n instead of Windows file endings with
 \r\n.