chore(docs): add markdownlint and cpell config files (and apply some linting) (#3140)

* chore(docs): apply some linting * chore(docs): add markdownlint and cpell config files * remove duplicate key * add extension recommendation * update cspell
2022-07-11 21:13:45 +02:00
parent b20a5d1fef
commit 3007303db7
23 changed files with 131 additions and 78 deletions
@@ -1,8 +1,9 @@
 # Installation Notes

-* If you don't enable `Reverse Proxy` on `Collabora` (It's not recommended as it is unsecure), in order for it to work you have to
-    * Remove `-o:ssl.termination=true -o:ssl.enable=false` from `Extra Parameters`.
-    * Set `Server Name` to `hostIP:port` (The port number you set for `NodePort`)
-    * Set `Service type` to `NodePort`
-    * Set `Port type` to `HTTPS`
-    * Disable certificate validation in the app you are going to use it. (eg. Nextcloud have a checkbox under Collabora's URL to disable Cert Validtation)
+If you don't enable `Reverse Proxy` on `Collabora` (It's not recommended as it is unsecure), in order for it to work you have to
+
+* Remove `-o:ssl.termination=true -o:ssl.enable=false` from `Extra Parameters`.
+* Set `Server Name` to `hostIP:port` (The port number you set for `NodePort`)
+* Set `Service type` to `NodePort`
+* Set `Port type` to `HTTPS`
+* Disable certificate validation in the app you are going to use it. (eg. Nextcloud have a checkbox under Collabora's URL to disable Cert Validation)
@@ -124,7 +124,7 @@ questions:
            default: "de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru"
        - variable: extra_params
          label: "Extra Parameters to add"
-          description: 'e.g. "--o:welcome.enable=false", See more on /etc/loolwsd/loowsd.xml. Separate params with space'
+          description: 'e.g. "--o:welcome.enable=false", See more on /etc/loolwsd/loolwsd.xml. Separate params with space'
          schema:
            type: string
            default: "--o:welcome.enable=false --o:logging.level=information --o:user_interface.mode=notebookbar --o:ssl.termination=true --o:ssl.enable=false"
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,5 +1,6 @@
-d# Installation Notes
+# Installation Notes

 ## Custom Models
+
 If you have custom models and you wan to use them, you have to add customStorage to this app. The default path to map is `/modelstore/detection`.
 In case you like to change it, you also have to change `Custom Models Path` field to the path you mapped as customStorage.
@@ -1,4 +1,4 @@
-## Ingress
+# Ingress

 This chart requires Ingress to be enabled after initial install due to the configuration of the application upstream (see [Duplicati forum post](https://forum.duplicati.com/t/error-message-in-browser-the-host-header-sent-by-the-client-is-not-allowed/5806)). Please install the application without Ingress, access settings of the application and add your hostname inside the settings of the app.

@@ -1,4 +1,5 @@
 # Important Notes
-The FireFlyiii developers have decided to split their program into multiple different add-on containers, implementing these ourselves into the App is EXTREMELY time-consuming. While we would appreciate people with experience building Helm Charts and adding the feature containers, we have decided to flag them "out of scope" for True Charts.
+
+The Firefly III developers have decided to split their program into multiple different add-on containers, implementing these ourselves into the App is EXTREMELY time-consuming. While we would appreciate people with experience building Helm Charts and adding the feature containers, we have decided to flag them "out of scope" for True Charts.

 If you really want to use them, you can use custom-app or big-blue-button. However, we do not actively support such a setup.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,8 +1,10 @@
 # Installation Notes

 - If you enable `Ingress` for this app, you need to have `SECURE_CONNECTION` set to `false` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
- `VNC` can't be `Ingressed`. if you want to use `VNC`, you must set this service to `Simple` instead of `clusterIP`.
+- You can't enable `Ingress` for `VNC` If you want to use `VNC`, you must set this service to `Simple` instead
 - `VNC` with `SECURE_CONNECTION` set `true`, only works with very few clients. One of them is `SSVNC`.
 - `SECURE_CONNECTION` affects both `WebUI` and `VNC`.

+---
+
 - If you are passing through devices such as `Optical Drives`, you have to Click `Container Security Settings` and set `PUID` to `0`.
@@ -1,9 +1,6 @@
 # Notes

-Meshroom in docker does not have weUIUI.
-
+Meshroom in docker does not have a webUI.
 You need an ssh client capable of X forwarding.
-
-You SSH into the app, with `ssh -p 10243 -X root@<NASIP> /opt/Meshroom_bundle/Meshroom`
-
+You SSH into the app, with `ssh -p 10243 -X root@<Your.Host.I.P.> /opt/Meshroom_bundle/Meshroom`
 Default password is `meshroom`
@@ -2,50 +2,40 @@

 ⚠️ **Warning This guide contains information that uses Advanced/Expert settings. As a result this will be outside the scope of support!** ⚠️

-# Running Multiple MC-Java Servers
+---
+
+## Running Multiple MC-Java Servers

 You can easily run Multiple MC Servers. You simply need to change the external ports, Be sure to use an unused port. There is no need to change the Minecraft port or RCON port in the server.properties

 MC Server 1

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server1.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server1.png" width="100%"/></a>
-</div>
+![mc-server1](https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server1.png)

 MC Server 2

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server2.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server2.png" width="100%"/></a>
-</div>
+![mc-server2](https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-server2.png)

-# Plugins DIR
+## Plugins DIR

 To easily get Plugins in to your MC server since PVC&#39;s are in use for the config storage you can add a host path storage for either /mods or /plugins depending on what your server needs like so

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-plugins.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-plugins.png" width="100%"/></a>
-</div>
+![mc-plugins](https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-plugins.png)

 This will give you an easy folder to drop the plugins in and they will then sync to /data/plugins or /data/mods , you will/may need to shell in to the app to periodically clean up old versions

-# Plugins/mods that need additional ports
+## Plugins/mods that need additional ports

 Using Dynmap as an example Under network and Services Check Show Expert config (remember the warning at the top?)

 Click Configure add Manual Custom Services and fill out like so also adding Configure additional service ports

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports1.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports1.png" width="100%"/></a>
-</div>
+![mc-modports1](https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports1.png)

 For the second server instance the setup is about the same one minor difference is the need to change the port for dynmap in the container to a new port and configure like so (note this could of just been my system being silly due to my tests and not rebooting)

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports2.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports2.png" width="100%"/></a>
-</div>
+![mc-modports2](https://truecharts.org/img/communityguide/apps/games/minecraft-java/mc-modports2.png)

 Dynmap Web working

-<div>
-<a href="https://truecharts.org/img/communityguide/apps/games/minecraft-java/dynmap.png"><img src="https://truecharts.org/img/communityguide/apps/games/minecraft-java/dynmap.png" width="100%"/></a>
-</div>
+![dynmap](https://truecharts.org/img/communityguide/apps/games/minecraft-java/dynmap.png)
@@ -5,20 +5,20 @@ For this reason we ask you not to file support requests on our Discord or Github

 While we consider the App layer "Stable", we simply cannot guarantee stability due to the nature of the Nextcloud Application inside the App.

-
-# Installation Notes
+## Installation Notes

 Nextcloud generates it's `config.php` file on the first startup/installation. Therefore you have to set some values correctly on the first try.
 Otherwise you will have to either re-install the App or edit the `config.php` manually, with the latter being out of our support scope.
 The mentioned values are:
-  - TRUSTED_PROXIES
-  - NODE_IP
-  - Ingress, if you plan to use it.
-  - Data storage location, type (eg. PVC, hostPath).

+- TRUSTED_PROXIES
+- NODE_IP
+- Ingress, if you plan to use it.
+- Data storage location, type (eg. PVC, hostPath).

 Also Nextcloud creates an Admin user on the first startup/installation, which you can only define it's username and password on the first install.
 Changing them later, will have no effect.
 The mentioned values are:
-  - NEXTCLOUD_ADMIN_USER
-  - NEXTCLOUD_ADMIN_PASSWORD
+
+- NEXTCLOUD_ADMIN_USER
+- NEXTCLOUD_ADMIN_PASSWORD