docs: updated upgrade parts, fixed typos

Author: thorsten

docs/administration.md

@@ -28,9 +28,9 @@ You can switch the current language in the administration backend, and you have
 ### 5.1.1 User Administration
 
 phpMyFAQ offers flexible management of privileges (or rights) for different users in the admin area. To search for a
-certain user, just start typing the username in the input form, and you'll get a list of hits for usernames. It is
+certain user, start typing the username in the input form, and you'll get a list of hits for usernames. It is
 possible to assign different privileges to real people (represented by the term users). Those privileges are very
-detailed and specific, so that you could allow a certain user to edit but not to delete an entry. It is very important
+detailed and specific, so that you could allow a certain user to edit but not to delete an entry. It is crucial
 to contemplate which user shall get which privileges. You could edit an entry by completely deleting all content, which
 would be equivalent to deleting the whole entry. The number of possible users is not limited by phpMyFAQ.
 
@@ -55,7 +55,7 @@ permissions, please set the permission level from _basic_ to _medium_ in the mai
 ### 5.2.1 Category Administration
 
 phpMyFAQ lets you create different categories and nested subcategories for your FAQs.
-You can also re-arrange your categories in a different order with drag'n'drop.
+You can re-arrange your categories in a different order and create nested ones with drag'n'drop.
 It is possible to use various languages per category, too; there's also a frontend to view all translated categories.
 For accessibility reasons, you should add a small description for every category.
 You can add an image for every category, which will be shown even on the start page if you flag this category with this
@@ -119,8 +119,8 @@ time with all the relevant data of the specific entry. The meaning of the fields
   be invisible. Suggested FAQs are deactivated by default to prevent any abuse.
 
 - **Sticky?**
-  If a FAQ is "sticky" it is a very important FAQ record and will always be shown on all pages on the right column.
-  You should mark records as sticky if they're very important for your whole FAQ. Sticky records also appear at the
+  If a FAQ is "sticky" it is a crucial FAQ record and will always be shown on all pages on the right column.
+  You should mark records as sticky if they're crucial for your whole FAQ. Sticky records also appear at the
   top positions of the lists of FAQ entries.
 
 - **Comments?**
@@ -158,31 +158,39 @@ phpMyFAQ lets visitors contribute to the FAQ by asking questions. Every visitor
 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 Comment Administration
+### 5.2.3 Sticky FAQs
+
+You can arrange the order of the sticky FAQs by drag'n'drop.
+The order of the sticky FAQs will be the same in the public frontend.
+
+### 5.2.4 Comment Administration
 
 In this frontend, you can see all comments that'd been posted in the FAQs and the news. You can't edit comments,
 but you can delete them with one easy click.
 
-### 5.2.4 Open questions
+### 5.2.5 Open Questions
 
-...
+On the "Open Questions" page, you can see all open questions that visitors have posted.
+You can answer them directly or, if they are not visible due to your configuration in the public area, you can activate
+them.
+Additionally, you can delete them, too.
 
-### 5.2.5 Glossary
+### 5.2.6 Glossary
 
 A glossary is a list of terms in a particular domain of knowledge with the definitions for those terms. You can add,
 edit and delete glossary items here. The items will be automatically displayed in <abbr> tags in the frontend.
 
-### 5.2.6 News Administration
+### 5.2.7 News Administration
 
 phpMyFAQ offers the ability to post news on the starting page of your FAQ. In the administration area you can create
 new news, edit existing news or delete them.
 
-### 5.2.7 Attachment Administration
+### 5.2.8 Attachment Administration
 
 In the attachment administration, you can see an overview of all all attachments with their filename, file size,
 language and MIME type. You can delete them, too.
 
-### 5.2.8 Tags Administration
+### 5.2.9 Tags Administration
 
 You can edit existing tags, of if you need to, you can delete the tag.
 
@@ -219,20 +227,22 @@ installation. You can export the report then as a CSV file.
 ## 5.4 Imports & Exports
 
 ### 5.4.1 Imports
+
 You can import faqs from a csv file. Further, you find an example of such a csv file:
 
 > [!IMPORTANT]
 > It is not allowed to have the first line of the following example file containing the headers in the uploaded file as well. Otherwise, the import will fail.
 
-| category-Id | question | answer | keywords | language code | author | email address of author | active | sticky |
-| --- | --- | --- | --- | --- | --- | --- | --- | --- |
-| 1 | What's the answer? | This one is the answer | question,answer | en | Thorsten | [email protected] | true | false |
-| 1 | Can you buy me an ice cream? | Strawberry or chocolate is available. | ice,strawberry,chocolate | en | Thorsten | [email protected] | true | true |
+| category-Id | question                     | answer                                | keywords                 | language code | author   | email address of author | active | sticky |
+| ----------- | ---------------------------- | ------------------------------------- | ------------------------ | ------------- | -------- | ----------------------- | ------ | ------ |
+| 1           | What's the answer?           | This one is the answer                | question,answer          | en            | Thorsten | [email protected]    | true   | false  |
+| 1           | Can you buy me an ice cream? | Strawberry or chocolate is available. | ice,strawberry,chocolate | en            | Thorsten | [email protected]    | true   | true   |
 
 > [!NOTE]
 > All cells are required except of the keywords. Additionally, you are able to use several keywords that are seperated with commas.
 
 ### 5.4.2 Exports
+
 You can export your contents of your whole FAQ or just some selected categories into four formats:
 
 - a JSON file
@@ -264,12 +274,7 @@ To back up the whole data located on your web server you can run our simple back
 Here you can edit the general, FAQ specific, search, spam protection, spam control center, SEO related, Social networks
 settings, Mail setup for SMTP, LDAP configuration, and API settings of phpMyFAQ.
 
-### 5.6.2 System information
-
-On this page phpMyFAQ displays some relevant system information like PHP version, database version or session path.
-Please use this information when report bugs.
-
-### 5.6.3 FAQ Multi-sites
+### 5.6.2 FAQ Multi-sites
 
 You can see a list of all multisite installations, and you're able to add new ones.
 
@@ -293,14 +298,31 @@ For example, if you want to use _faq.example.org_ and _beta.faq.example.org_, it
             |-- constants.php
             `-- database.php
 
-### 5.6.4 Stop Words configuration
+### 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
 very low relevance like the English word _the_.
 
+### 5.6.4 phpMyFAQ Update (Experimental feature)
+
+If you're running phpMyFAQ 4.0.0 or later, you can use the built-in automatic upgrade feature.
+You can 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
+
 ### 5.6.5 Elasticsearch configuration
 
 Here you can create and drop the Elasticsearch index, and you can run a full import of all data from your database
 into the Elasticsearch index. You can also see some Elasticsearch relevant usage data. This page is only available if
 Elasticsearch is enabled.
+
+### 5.6.2 System information
+
+On this page phpMyFAQ displays some relevant system information like PHP version, database version or session path.
+Please use this information when report bugs.

docs/development.md

@@ -7,7 +7,7 @@ is a templates/default directory where the default layouts get shipped.
 
 In phpMyFAQ code and layout are separated. The layout is based on several template files, that you can modify to suit
 your own needs. The most important files for phpMyFAQ's default layout can be found in the directory
-_assets/themes/default/_. All original templates are valid HTML5 based on Bootstrap v5.3
+_assets/themes/default/_. All original templates are valid HTML5 based on Bootstrap v5.3.
 
 ### 6.1.1 Creating a custom layout
 
@@ -159,24 +159,24 @@ During development, you can use the watch mode:
 
     $ pnpm build:watch
 
-To run the PHPUnit based tests, you can use the following command:
+To run the PHPUnit-based tests, you can use the following command:
 
     $ composer test
 
-To run the Jest based tests, you can use the following command:
+To run the Jest-based tests, you can use the following command:
 
     $ pnpm test
 
 ### 6.4.7 Rebase your Patch
 
 Before submitting your patch, please update your local branch:
 
-    $ git checkout 3.2
+    $ git checkout 4.0
     $ git fetch upstream
-    $ git merge upstream/3.2
+    $ git merge upstream/4.0
     $ git checkout YOUR_BRANCH_NAME
-    $ git rebase 3.2
+    $ git rebase 4.0
 
 ### 6.4.8 Make a Pull Request
 
-You can now make a pull request on the phpMyFAQ Github repository.
+You can now make a pull request on the phpMyFAQ GitHub repository.

docs/index.md

@@ -1,20 +1,32 @@
 # phpMyFAQ Manual
 
-phpMyFAQ is a multilingual, completely database-driven FAQ system. It supports various databases to store all data,
-PHP 8.1+ is needed to access this data. phpMyFAQ also offers a multi-language Content Management System with a
-WYSIWYG editor and an Image Manager, real time search support with Elasticsearch, flexible multi-user support with user
-and group based permissions on categories and records, a wiki-like revision feature, a news system, user-tracking,
-40+ supported languages, enhanced automatic content negotiation, HTML5/CSS3 based responsive templates with support for
-own text and HTML snippets, PDF-support, a backup-system, a dynamic sitemap, related FAQs, tagging, built-in spam
-protection systems, OpenLDAP, Microsoft Active Directory, and Microsoft Entra ID support, and an easy-to-use
-installation script. You can run phpMyFAQ on almost every web hosting provider or in the cloud in a Docker container.
+phpMyFAQ is a comprehensive, multilingual FAQ system that is entirely database-driven.
+It is compatible with a variety of databases for data storage and requires PHP 8.2+ for data access.
+The system features a multi-language Content Management System equipped with a WYSIWYG editor and an Image Manager.
+It also provides real-time search capabilities with Elasticsearch.
 
-This documentation should help you with installing, updating, using and administrating phpMyFAQ.
+phpMyFAQ supports flexible multi-user functionality,
+offering user and group-based permissions on categories and records.
+It includes a wiki-like revision feature, a news system, and configurable user-tracking.
+With support for over 40 languages, it also boasts enhanced automatic content negotiation and HTML5- / CSS3-based
+responsive templates.
+These templates allow for the inclusion of your own text and HTML snippets.
+
+Additional features include PDF support, a backup system, a dynamic sitemap,
+related FAQs, tagging, and built-in spam protection systems.
+It also supports OpenLDAP, Microsoft Active Directory, and Microsoft Entra ID.
+The system is easy to install, thanks to its user-friendly installation script.
+
+phpMyFAQ is versatile
+and can be run on almost any web hosting provider or deployed in the cloud using a Docker container.
+
+This documentation serves as a guide to help you install, update, use, and administer phpMyFAQ effectively.
 
 ### 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 phpMyFAQ.
+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
+phpMyFAQ.
 
 The only restrictions apply to the copyright, which remains at all times at Thorsten Rinne and the phpMyFAQ Team. Any
 modified versions of phpMyFAQ will also fall under the terms of MPL. Any other program that may only be accessing
@@ -25,7 +37,7 @@ met.
 
 We decided to use MPL as the licensing model for phpMyFAQ because 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
+its licensing model. When compared to other licensing models, its text is short and easily comprehensible, even for
 newcomers.
 
 This documentation is licensed under a [Creative Commons License](http://creativecommons.org/licenses/by/2.0/).

docs/installation.md

@@ -7,7 +7,7 @@ To install it, you will need a web server that meets the following requirements:
 
 ### PHP requirements
 
-- version 8.1 or later
+- version 8.2 or later
 - memory_limit = 128M (the more the better)
 - cURL support
 - GD support
@@ -48,12 +48,12 @@ In case PHP runs as a module of the Apache, you will have to be able to do a cho
 files and directories must be owned by the web server's user.
 
 You can determine which versions your web server is running by creating a file called **info.php** with the following
-content: `<?php phpinfo(); ?>`
+content: `<?php phpinfo();`
 
 Upload this file to your webspace and open it using your browser. The installation-script checks which version of PHP
 is installed on your server. Should you not meet the requirements, you cannot start the installation process.
 
-In case you're running PHP before 8.1, you cannot use phpMyFAQ.
+In case you're running PHP before 8.2, you cannot use phpMyFAQ.
 
 phpMyFAQ uses a modern HTML5/CSS3 powered markup. The supported browsers are the latest Mozilla Firefox
 (Windows/macOS/Linux), the latest Safari (macOS/iOS), the latest Chrome (Windows/macOS/Linux), the latest Opera
@@ -325,10 +325,11 @@ of performance reasons, its availability is checked automatically at the run tim
 
 Please be aware:
 
-- Disabling encryption will cause all files be saved unencrypted. In this case you'll benefit sparing disk space,
+- Disabling encryption will cause all files be saved unencrypted. In this case, you'll benefit from sparing disk space,
   because identical files will be saved only once.
-- Do not change the default attachment encryption key once files was uploaded. Doing so will cause all the previously
-  uploaded files to be wrong decrypted. If you need to change the default key, you will have to re-upload all files.
+- 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.
+  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
   etc), so there is no way to asses a file directly using the name it was uploaded under.
@@ -359,9 +360,10 @@ To disable highlighting altogether use the "nohighlight" class:
 
 ## 2.16 Elasticsearch Support
 
-To improve the search performance and quality of search results it's possible to use Elasticsearch. 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
+To improve the search performance and quality of search results, it's possible to use Elasticsearch.
+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
 index with a user-friendly interface.

docs/thank-you.md

@@ -2,8 +2,8 @@
 
 Thank you for using phpMyFAQ! :-)
 
-Authors: Thorsten Rinne, Stephan Hochhaus, Markus Gläser
+Authors: Thorsten Rinne, Stephan Hochhaus, Markus Gläser, Jan Harms
 
-© 2001-2023 phpMyFAQ Team
+© 2001-2024 phpMyFAQ Team
 
 This documentation is licensed under a [Creative Commons License](http://creativecommons.org/licenses/by/2.0/).

docs/update.md

@@ -13,7 +13,7 @@ support for updating an old FAQ from the 1.x or 2.x series, [please email us](th
 
 ## Before you upgrade
 
-Please make sure that you're running at least PHP 8.1, otherwise the upgrade won't work.
+Please make sure that you're running at least PHP 8.2, otherwise the upgrade won't work.
 
 ## Upgrading from phpMyFAQ 3.0.x
 
@@ -78,6 +78,8 @@ updated.
 
 ## Upgrading from phpMyFAQ 4.0.x
 
+### Manual upgrade
+
 Please make a full backup before you run the upgrade!
 First, log in as admin into the admin section and enable the maintenance mode.
 Second, you have to delete all files **except**:
@@ -92,10 +94,23 @@ URL in your browser:
 Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be
 updated.
 
-## Modifying templates for phpMyFAQ 3.2
+### Automatic upgrade (Experimental feature)
+
+If you're running phpMyFAQ 4.0.0 or later, you can use the built-in automatic upgrade feature.
+Log in as admin into the admin section and enable the maintenance mode.
+Then go to the "phpMyFAQ Update" page in the configuration section 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
+
+## Modifying templates for phpMyFAQ 4.0
 
 We recommend you take a look at the main [Bootstrap documentation](https://getbootstrap.com/).
-Please don't forget that the style sheets are written with [SCSS](https://sass-lang.com/).
+Please remember that the style sheets are written with [SCSS](https://sass-lang.com/).
 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/).