Fix spelling and grammar mistakes in documentation (#1127)

* Initial plan

* Fix spelling and grammar mistakes in documentation

Co-authored-by: jbtronics <5410681+jbtronics@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jbtronics <5410681+jbtronics@users.noreply.github.com>

CONTRIBUTING.md

@@ -20,7 +20,7 @@ was translated in other languages (this is possible via the "Other languages" dr
 ## Project structure
 Part-DB uses symfony's recommended [project structure](https://symfony.com/doc/current/best_practices.html).
 Interesting folders are:
-* `public`: Everything in this directory will be publicy accessible via web. Use this folder to serve static images.
+* `public`: Everything in this directory will be publicly accessible via web. Use this folder to serve static images.
 * `assets`: The frontend assets are saved here. You can find the javascript and CSS code here.
 * `src`: Part-DB's PHP code is saved here. Note that the sub directories are structured by the classes purposes (so use `Controller` Controllers, `Entities` for Database models, etc.)
 * `translations`: The translations used in Part-DB are saved here
@@ -49,7 +49,7 @@ Part-DB uses GitHub actions to run various tests and checks on the code:
 * PHPunit tests run successful
 * Config files, translations and templates has valid syntax
 * Doctrine schema valid
-* No known vulnerable dependecies are used
+* No known vulnerable dependencies are used
 * Static analysis successful (phpstan with `--level=2`)
 
 Further the code coverage of the PHPunit tests is determined and uploaded to [CodeCov](https://codecov.io/gh/Part-DB/Part-DB-server).

README.md

@@ -29,8 +29,8 @@ If you want to test Part-DB without installing it, you can use [this](https://de
 
 You can log in with username: *user* and password: *user*.
 
-Every change to the master branch gets automatically deployed, so it represents the current development progress and is
+Every change to the master branch gets automatically deployed, so it represents the current development progress and
-may not completely stable. Please mind, that the free Heroku instance is used, so it can take some time when loading
+may not be completely stable. Please mind, that the free Heroku instance is used, so it can take some time when loading
 the page
 for the first time.
 

docs/api/intro.md

@@ -17,7 +17,7 @@ This allows external applications to interact with Part-DB, extend it or integra
 > Some features might be missing or not working yet.
 > Also be aware, that there might be security issues in the API, which could allow attackers to access or edit data via
 > the API, which
-> they normally should be able to access. So currently you should only use the API with trusted users and trusted
+> they normally should not be able to access. So currently you should only use the API with trusted users and trusted
 > applications.
 
 Part-DB uses [API Platform](https://api-platform.com/) to provide the API, which allows for easy creation of REST APIs
@@ -106,11 +106,11 @@ This is a great way to test the API and see how it works, without having to writ
 
 By default, all list endpoints are paginated, which means only a certain number of results is returned per request.
 To get another page of the results, you have to use the `page` query parameter, which contains the page number you want
-to get (e.g. `/api/categoues/?page=2`).
+to get (e.g. `/api/categories/?page=2`).
 When using JSONLD, the links to the next page are also included in the `hydra:view` property of the response.
 
 To change the size of the pages (the number of items in a single page) use the `itemsPerPage` query parameter (
-e.g. `/api/categoues/?itemsPerPage=50`).
+e.g. `/api/categories/?itemsPerPage=50`).
 
 See [API Platform docs](https://api-platform.com/docs/core/pagination) for more infos.
 

docs/concepts.md

@@ -28,7 +28,7 @@ A part entity has many fields, which can be used to describe it better. Most of
   the comment field or the specifications
 * **Category** (Required): The category (see there) to which this part belongs to.
 * **Tags**: The list of tags this part belongs to. Tags can be used to group parts logically (similar to the category),
-  but tags are much less strict and formal (they don't have to be defined forehands) and you can assign multiple tags to
+  but tags are much less strict and formal (they don't have to be defined beforehand) and you can assign multiple tags to
   a part. When clicking on a tag, a list with all parts which have the same tag, is shown.
 * **Min Instock**: *Not really implemented yet*. Parts where the total instock is below this value, will show up for
   ordering.

docs/configuration.md

@@ -10,7 +10,7 @@ Part-DBs behavior can be configured to your needs. There are different kinds of
 user-changeable (changeable dynamically via frontend), options that can be configured by environment variables, and
 options that are only configurable via Symfony config files.
 
-## User configruation
+## User configuration
 
 The following things can be changed for every user and a user can change it for himself (if he has the correct permission
 for it). Configuration is either possible via the user's own settings page (where you can also change the password) or via
@@ -43,7 +43,7 @@ options listed, see `.env` file for the full list of possible env variables.
 Environment variables allow to overwrite settings in the web interface. This is useful, if you want to enforce certain
 settings to be unchangable by users, or if you want to configure settings in a central place in a deployed environment.
 On the settings page, you can hover over a setting to see, which environment variable can be used to overwrite it, it 
-is shown as tooltip. API keys or similar sensitve data which is overwritten by env variables, are redacted on the web
+is shown as tooltip. API keys or similar sensitive data which is overwritten by env variables, are redacted on the web
 interface, so that even administrators cannot see them (only the last 2 characters and the length).
 
 For technical and security reasons some settings can only be configured via environment variables and not via the web
@@ -116,7 +116,7 @@ bundled with Part-DB. Set `DATABASE_MYSQL_SSL_VERIFY_CERT` if you want to accept
   value should be handled as confidential data and not shared publicly.
 * `SHOW_PART_IMAGE_OVERLAY`: Set to 0 to disable the part image overlay, which appears if you hover over an image in the
   part image gallery
-* `IPN_SUGGEST_REGEX`: A global regular expression, that part IPNs have to fullfill. Enforce your own format for your users.
+* `IPN_SUGGEST_REGEX`: A global regular expression, that part IPNs have to fulfill. Enforce your own format for your users.
 * `IPN_SUGGEST_REGEX_HELP`: Define your own user help text for the Regex format specification.
 * `IPN_AUTO_APPEND_SUFFIX`: When enabled, an incremental suffix will be added to the user input when entering an existing 
 * IPN again upon saving.

docs/index.md

@@ -18,8 +18,7 @@ It is installed on a web server and so can be accessed with any browser without
 > You can log in with username: **user** and password: **user**, to change/create data.
 >
 > Every change to the master branch gets automatically deployed, so it represents the current development progress and
-> is
+> may not be completely stable. Please mind, that the free Heroku instance is used, so it can take some time when loading
-> maybe not completely stable. Please mind, that the free Heroku instance is used, so it can take some time when loading
 > the page
 > for the first time.
 
@@ -53,7 +52,7 @@ It is installed on a web server and so can be accessed with any browser without
   KiCad and see available   parts from Part-DB directly inside KiCad.
 
 With these features Part-DB is useful to hobbyists, who want to keep track of their private electronic parts inventory,
-or makerspaces, where many users have should have (controlled) access to the shared inventory.
+or makerspaces, where many users should have (controlled) access to the shared inventory.
 
 Part-DB is also used by small companies and universities for managing their inventory.
 

docs/installation/choosing_database.md

@@ -38,7 +38,7 @@ you have started creating data**. So you should choose the database type for you
 
 * **Performance**: SQLite is not as fast as MySQL or PostgreSQL, especially when using complex queries or many users.
 * **Emulated RegEx search**: SQLite does not support RegEx search natively. Part-DB can emulate it, however that is pretty slow.
-* **Emualted natural sorting**: SQLite does not support natural sorting natively. Part-DB can emulate it, but it is pretty slow.
+* **Emulated natural sorting**: SQLite does not support natural sorting natively. Part-DB can emulate it, but it is pretty slow.
 * **Limitations with Unicode**: SQLite has limitations in comparisons and sorting of Unicode characters, which might lead to
   unexpected behavior when using non-ASCII characters in your data. For example `µ` (micro sign) is not seen as equal to 
   `μ` (greek minuscule mu), therefore searching for `µ` (micro sign) will not find parts containing `μ` (mu) and vice versa.
@@ -131,7 +131,7 @@ The host (here 127.0.0.1) and port should also be specified according to your My
 In the `serverVersion` parameter you can specify the version of the MySQL/MariaDB server you are using, in the way the server returns it 
 (e.g. `8.0.37` for MySQL and `10.4.14-MariaDB`). If you do not know it, you can leave the default value.
 
-If you want to use a unix socket for the connection instead of a TCP connnection, you can specify the socket path in the `unix_socket` parameter.
+If you want to use a unix socket for the connection instead of a TCP connection, you can specify the socket path in the `unix_socket` parameter.
 ```shell
 DATABASE_URL="mysql://user:password@localhost/database?serverVersion=8.0.37&unix_socket=/var/run/mysqld/mysqld.sock"
 ```
@@ -150,7 +150,7 @@ In the `serverVersion` parameter you can specify the version of the PostgreSQL s
 
 The `charset` parameter specify the character set of the database. It should be set to `utf8` to ensure that all characters are stored correctly.
 
-If you want to use a unix socket for the connection instead of a TCP connnection, you can specify the socket path in the `host` parameter.
+If you want to use a unix socket for the connection instead of a TCP connection, you can specify the socket path in the `host` parameter.
 ```shell
 DATABASE_URL="postgresql://db_user@localhost/db_name?serverVersion=16.6&charset=utf8&host=/var/run/postgresql"
 ```
@@ -177,6 +177,6 @@ In natural sorting, it would be sorted as:
 Part-DB can sort names in part tables and tree views naturally. PostgreSQL and MariaDB 10.7+ support natural sorting natively,
 and it is automatically used if available.
 
-For SQLite and MySQL < 10.7 it has to be emulated if wanted, which is pretty slow. Therefore it has to be explicity enabled by setting the
+For SQLite and MySQL < 10.7 it has to be emulated if wanted, which is pretty slow. Therefore it has to be explicitly enabled by setting the
 `DATABASE_EMULATE_NATURAL_SORT` environment variable to `1`. If it is 0 the classical binary sorting is used, on these databases. The emulations
 might have some quirks and issues, so it is recommended to use a database which supports natural sorting natively, if you want to use it.

docs/installation/email.md

@@ -19,7 +19,7 @@ automatic mail providers (like MailChimp or SendGrid). If you want to use one of
 Mailer documentation for more information.
 
 We will only cover the configuration of an SMTP provider here, which is sufficient for most use-cases.
-You will need an email account, which you can use send emails from via password-bases SMTP authentication, this account
+You will need an email account, which you can use to send emails from via password-based SMTP authentication, this account
 should be dedicated to Part-DB.
 
 To configure the SMTP provider, you have to set the following environment variables:

docs/installation/installation_docker.md

@@ -143,11 +143,11 @@ services:
        # - DB_AUTOMIGRATE=true
 
       # You can configure Part-DB using the webUI or environment variables
-      # However you can add add any other environment configuration you want here
+      # However you can add any other environment configuration you want here
       # See .env file for all available options or https://docs.part-db.de/configuration.html
 
-      # Override value if you want to show to show a given text on homepage.
+      # Override value if you want to show a given text on homepage.
-      # When this is outcommented the webUI can be used to configure the banner
+      # When this is commented out the webUI can be used to configure the banner
       #- BANNER=This is a test banner<br>with a line break
 
   database:

docs/installation/nginx.md

@@ -7,7 +7,7 @@ nav_order: 10
 
 # Nginx
 
-You can also use [nginx](https://www.nginx.com/) as webserver for Part-DB. Setup Part-DB with apache is a bit easier, so
+You can also use [nginx](https://www.nginx.com/) as webserver for Part-DB. Setting up Part-DB with Apache is a bit easier, so
 this is the method shown in the guides. This guide assumes that you already have a working nginx installation with PHP
 configured.
 

docs/installation/saml_sso.md

@@ -21,7 +21,7 @@ LDAP or Active Directory server.
 
 {: .warning }
 > This feature is currently in beta. Please report any bugs you find.
-> So far it has only tested with Keycloak, but it should work with any SAML 2.0 compatible identity provider.
+> So far it has only been tested with Keycloak, but it should work with any SAML 2.0 compatible identity provider.
 
 This guide will show you how to configure Part-DB with [Keycloak](https://www.keycloak.org/) as the SAML identity
 provider, but it should work with any SAML 2.0 compatible identity provider.
@@ -75,8 +75,8 @@ the [Keycloak Getting Started Guide](https://www.keycloak.org/docs/latest/gettin
 
 ### Configure Part-DB to use SAML
 
-1. Open the `.env.local` file of Part-DB (or the docker-compose.yaml) for edit
+1. Open the `.env.local` file of Part-DB (or the docker-compose.yaml) for editing
-2. Set the `SAMLP_SP_PRIVATE_KEY` environment variable to the content of the private key file you downloaded in the
+2. Set the `SAML_SP_PRIVATE_KEY` environment variable to the content of the private key file you downloaded in the
    previous step. It should start with `MIEE` and end with `=`.
 3. Set the `SAML_SP_X509_CERT` environment variable to the content of the Certificate field shown in the `Keys` tab of
    the SAML client in Keycloak. It should start with `MIIC` and end with `=`.

docs/troubleshooting.md

@@ -9,7 +9,7 @@ Sometimes things go wrong and Part-DB shows an error message. This page should h
 
 ## Error messages
 
-When a common, easy fixable error occurs (like a non-up-to-date database), Part-DB will show you some short instructions
+When a common, easily fixable error occurs (like a non-up-to-date database), Part-DB will show you some short instructions
 on how to fix the problem. If you have a problem that is not listed here, please open an issue on GitHub.
 
 ## General procedure

docs/upgrade/1_to_2.md

@@ -27,7 +27,7 @@ about the requirements at all.
 
 ## Changes
 * Configuration is now preferably done via a web settings interface. You can still use environment variables, these overwrite
-the settings in the web interface. Existing configuration will still work, but you should consider migriting them to the
+the settings in the web interface. Existing configuration will still work, but you should consider migrating them to the
 web interface as described below.
 * The `config/banner.md` file that could been used to customize the banner text, was removed. You can now set the banner text
   directly in the admin interface, or by setting the `BANNER` environment variable. If you want to keep your existing
@@ -43,7 +43,7 @@ The upgrade process works very similar to a normal (minor release) upgrade.
 
 ### Direct installation
 
-**Be sure to execute the following steps as the user that owns the Part-DB files (e.g. `www-data`, or your webserver user). So prepend a `sudo -u wwww-data` where necessary.**
+**Be sure to execute the following steps as the user that owns the Part-DB files (e.g. `www-data`, or your webserver user). So prepend a `sudo -u www-data` where necessary.**
 
 1. Make a backup of your existing Part-DB installation, including the database, data directories and the configuration files and `.env.local` file.
 The `php bin/console partdb:backup` command can help you with this.
@@ -51,7 +51,7 @@ The `php bin/console partdb:backup` command can help you with this.
 3. Remove the `var/cache/` directory inside the Part-DB installation to ensure that no old cache files remain.
 4. Run `composer install --no-dev -o` to update the dependencies.
 5. Run `yarn install` and `yarn build` to update the frontend assets.
-6. Rund `php bin/console doctrine:migrations:migrate` to update the database schema.
+6. Run `php bin/console doctrine:migrations:migrate` to update the database schema.
 7. Clear the cache with `php bin/console cache:clear`.
 8. Open your Part-DB instance in the browser and log in as an admin user.
 9. Go to the user or group permissions page, and give yourself (and other administrators) the right to change system settings (under "System" and "Configuration").
@@ -79,7 +79,7 @@ To change it, you must migrate your environment variable configuration to the ne
 
 For this there is the new console command `settings:migrate-env-to-settings`, which reads in all environment variables used to overwrite
 settings and write them to the database, so that you can safely delete them from your environment variable configuration afterwards, without
-loosing your configuration.
+losing your configuration.
 
 To run the command, execute `php bin/console settings:migrate-env-to-settings --all` as webserver user (or run `docker exec --user=www-data -it partdb php bin/console settings:migrate-env-to-settings --all` for docker containers).
 It will list you all environment variables, it found and ask you for confirmation to migrate them. Answer with `yes` to migrate them and hit enter.

docs/upgrade/index.md

@@ -6,4 +6,4 @@ has_children: true
 ---
 
 This section provides information on how to upgrade Part-DB to the latest version.
-This is intended for major release upgrades, where requirements or things changes significantly.
+This is intended for major release upgrades, where requirements or things change significantly.

docs/upgrade/upgrade_legacy.md

@@ -24,7 +24,7 @@ sections carefully before proceeding to upgrade.
   also more sensitive stuff like database migration works via CLI now, so you should have console access on your server.
 * Markdown/HTML is now used instead of BBCode for rich text in description and command fields.
   It is possible to migrate your existing BBCode to Markdown
-  via `php bin/console php bin/console partdb:migrations:convert-bbcode`.
+  via `php bin/console partdb:migrations:convert-bbcode`.
 * Server exceptions are not logged into event log anymore. For security reasons (exceptions can contain sensitive
   information) exceptions are only logged to server log (by default under './var/log'), so only the server admins can access it.
 * Profile labels are now saved in the database (before they were saved in a separate JSON file). **The profiles of legacy

docs/usage/backup_restore.md

@@ -27,7 +27,7 @@ for more info about these options.
 
 ## Backup (manual)
 
-3 parts have to be backup-ed: The configuration files, which contain the instance-specific options, the
+3 parts have to be backed up: The configuration files, which contain the instance-specific options, the
 uploaded files of attachments, and the database containing the most data of Part-DB.
 Everything else like thumbnails and cache files, are recreated automatically when needed.
 
@@ -56,7 +56,7 @@ interface (`mysqldump -uBACKUP -pPASSWORD DATABASE`)
 ## Restore
 
 Install Part-DB as usual as described in the installation section, except for the database creation/migration part. You
-have to use the same database type (SQLite or MySQL) as on the backuped server instance.
+have to use the same database type (SQLite or MySQL) as on the backed up server instance.
 
 ### Restore configuration
 
@@ -71,7 +71,7 @@ Copy the `uploads/` and the `public/media/` folder from your backup into your ne
 
 #### SQLite
 
-Copy the backup-ed `app.db` into the database folder normally `var/app.db` in Part-DB root folder.
+Copy the backed up `app.db` into the database folder normally `var/app.db` in Part-DB root folder.
 
 #### MySQL / MariaDB
 

docs/usage/eda_integration.md

@@ -60,7 +60,7 @@ If you type in a character, you will get an autocomplete list of all symbols and
 
 ### Parts and category visibility
 
-Only parts and their categories, on which there is any kind of EDA metadata are defined show up in KiCad. So if you want to see parts in KiCad,
+Only parts and their categories on which there is any kind of EDA metadata defined show up in KiCad. So if you want to see parts in KiCad,
 you need to define at least a symbol, footprint, reference prefix, or value on a part, category or footprint.
 
 You can use the "Force visibility" checkbox on a part or category to override this behavior and force parts to be visible or hidden in KiCad.

docs/usage/getting_started.md

@@ -6,7 +6,7 @@ nav_order: 4
 
 # Getting started
 
-After Part-DB you should begin with customizing the settings, and setting up the basic structures.
+After Part-DB you should begin with customizing the settings and setting up the basic structures.
 Before starting, it's useful to read a bit about the [concepts of Part-DB]({% link concepts.md %}).
 
 1. TOC

docs/usage/import_export.md

@@ -49,7 +49,7 @@ You can upload the file that should be imported here and choose various options
   review" after the import. This can be useful if you want to review all imported parts before using them.
 * **Create unknown data structures**: If this is selected Part-DB will create new data structures (like categories,
   manufacturers, etc.) if no data structure(s) with the same name and path already exists. If this is not selected, only
-  existing data structures will be used and if no matching data strucure is found, the imported parts field will be empty.
+  existing data structures will be used and if no matching data structure is found, the imported parts field will be empty.
 * **Path delimiter**: Part-DB allows you to create/select nested data structures (like categories, manufacturers, etc.)
   by using a path (e.g. `Category 1->Category 1.1`, which will select/create the `Category 1.1` whose parent
   is `Category 1`). This path is separated by the path delimiter. If you want to use a different path delimiter than the

docs/usage/information_provider_system.md

@@ -78,7 +78,7 @@ results will be shown.
 ## Data providers
 
 The system tries to be as flexible as possible, so many different information sources can be used.
-Each information source is called am "info provider" and handles the communication with the external source.
+Each information source is called an "info provider" and handles the communication with the external source.
 The providers are just a driver that handles the communication with the different external sources and converts them
 into a common format Part-DB understands.
 That way it is pretty easy to create new providers as they just need to do very little work.
@@ -157,7 +157,7 @@ again, to establish a new connection.
 
 ### TME
 
-The TME provider uses the API of [TME](https://www.tme.eu/) to search for parts and getting shopping information from
+The TME provider uses the API of [TME](https://www.tme.eu/) to search for parts and get shopping information from
 them.
 To use it you have to create an account at TME and get an API key on the [TME API page](https://developers.tme.eu/en/).
 You have to generate a new anonymous key there and enter the key and secret in the Part-DB env configuration (see
@@ -176,10 +176,10 @@ The following env configuration options are available:
 
 ### Farnell / Element14 / Newark
 
-The Farnell provider uses the [Farnell API](https://partner.element14.com/) to search for parts and getting shopping
+The Farnell provider uses the [Farnell API](https://partner.element14.com/) to search for parts and get shopping
 information from [Farnell](https://www.farnell.com/).
 You have to create an account at Farnell and get an API key on the [Farnell API page](https://partner.element14.com/).
-Register a new application there (settings does not matter, as long as you select the "Product Search API") and you will
+Register a new application there (settings do not matter, as long as you select the "Product Search API") and you will
 get an API key.
 
 The following env configuration options are available:
@@ -191,7 +191,7 @@ The following env configuration options are available:
 
 ### Mouser
 
-The Mouser provider uses the [Mouser API](https://www.mouser.de/api-home/) to search for parts and getting shopping
+The Mouser provider uses the [Mouser API](https://www.mouser.de/api-home/) to search for parts and get shopping
 information from [Mouser](https://www.mouser.com/).
 You have to create an account at Mouser and register for an API key for the Search API on
 the [Mouser API page](https://www.mouser.de/api-home/).
@@ -226,7 +226,7 @@ An API key is not required, it is enough to enable the provider using the follow
 
 ### OEMsecrets
 
-The oemsecrets provider uses the [oemsecrets API](https://www.oemsecrets.com/) to search for parts and getting shopping
+The oemsecrets provider uses the [oemsecrets API](https://www.oemsecrets.com/) to search for parts and get shopping
 information from them. Similar to octopart it aggregates offers from different distributors.
 
 You can apply for a free API key on the [oemsecrets API page](https://www.oemsecrets.com/api/) and put the key you get

docs/usage/labels.md

@@ -6,7 +6,7 @@ parent: Usage
 
 # Labels
 
-Part-DB support the generation and printing of labels for parts, part lots and storage locations.
+Part-DB supports the generation and printing of labels for parts, part lots and storage locations.
 You can use the "Tools -> Label generator" menu entry to create labels or click the label generation link on the part.
 
 You can define label templates by creating Label profiles. This way you can create many similar-looking labels with for

docs/usage/tips_tricks.md

@@ -88,9 +88,9 @@ the user as "owner" of a part lot. This way, only he is allowed to add or remove
 
 ## Update notifications
 
-Part-DB can show you a notification that there is a newer version than currently installed available. The notification
+Part-DB can show you a notification that there is a newer version than currently installed. The notification
 will be shown on the homepage and the server info page.
-It is only be shown to users which has the `Show available Part-DB updates` permission.
+It is only shown to users which have the `Show available Part-DB updates` permission.
 
 For the notification to work, Part-DB queries the GitHub API every 2 days to check for new releases. No data is sent to
 GitHub besides the metadata required for the connection (so the public IP address of your computer running Part-DB).
@@ -98,6 +98,6 @@ If you don't want Part-DB to query the GitHub API, or if your server can not rea
 update notifications by setting the `CHECK_FOR_UPDATES` option to `false`.
 
 ## Internet access via proxy
-If you server running Part-DB does not have direct access to the internet, but has to use a proxy server, you can configure
+If your server running Part-DB does not have direct access to the internet, but has to use a proxy server, you can configure
 the proxy settings in the `.env.local` file (or docker env config). You can set the `HTTP_PROXY` and `HTTPS_PROXY` environment
 variables to the URL of your proxy server. If your proxy server requires authentication, you can include the username and password in the URL.