Run pre-commit on docs

README.md

@@ -29,13 +29,13 @@ Also, there's docs to help with deployment:
   - [Kubernetes (frappe/helm)](https://helm.erpnext.com),
 - [site operations](docs/site-operations.md).
 - Other
-   - [add custom domain using traefik](docs/add-custom-domain-using-traefik.md)
+  - [add custom domain using traefik](docs/add-custom-domain-using-traefik.md)
-   - [backup and push cron jobs](docs/backup-and-push-cronjob.md)
+  - [backup and push cron jobs](docs/backup-and-push-cronjob.md)
-   - [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)
+  - [bench console and vscode debugger](docs/bench-console-and-vscode-debugger.md)
-   - [build version 10](docs/build-version-10-images.md)
+  - [build version 10](docs/build-version-10-images.md)
-   - [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
+  - [connect to localhost services from containers for local app development](docs/connect-to-localhost-services-from-containers-for-local-app-development.md)
-   - [patch code from images](docs/patch-code-from-images.md)
+  - [patch code from images](docs/patch-code-from-images.md)
-   - [port based multi tenancy](docs/port-based-multi-tenancy.md)
+  - [port based multi tenancy](docs/port-based-multi-tenancy.md)
 - [Troubleshoot](docs/troubleshoot.md)
 
 # Custom app

docs/add-custom-domain-using-traefik.md

@@ -1,13 +1,13 @@
 Add following labels to `frontend` service
 
 ```yaml
-  traefik.http.routers.custom-domain.rule: Host(`custom.localhost`)
+traefik.http.routers.custom-domain.rule: Host(`custom.localhost`)
-  # Comment the entrypoints label if traefik already has default entrypoint set
+# Comment the entrypoints label if traefik already has default entrypoint set
-  traefik.http.routers.custom-domain.entrypoints: web
+traefik.http.routers.custom-domain.entrypoints: web
-  traefik.http.middlewares.custom-domain.headers.customrequestheaders.Host: mysite.localhost
+traefik.http.middlewares.custom-domain.headers.customrequestheaders.Host: mysite.localhost
-  traefik.http.routers.custom-domain.middlewares: custom-domain
+traefik.http.routers.custom-domain.middlewares: custom-domain
-  # Add following header only if TLS is needed in case of live server
+# Add following header only if TLS is needed in case of live server
-  traefik.http.routers.custom-domain.tls.certresolver: main-resolver
+traefik.http.routers.custom-domain.tls.certresolver: main-resolver
 ```
 
 Example:

docs/backup-and-push-cronjob.md

@@ -37,10 +37,10 @@ volumes:
 networks:
   frappe-network:
     external: true
-
 ```
 
 Note:
+
 - In Above stack, `backup` runs every 3 hours.
 - Change image and tag version as per need.
 - Change environment variables as per the bucket credentials.

docs/bench-console-and-vscode-debugger.md

@@ -1,18 +1,16 @@
 Add the following configuration to `launch.json` `configurations` array to start bench console and use debugger. Replace `mysite.localhost` with appropriate site. Also replace `frappe-bench` with name of the bench directory.
 
 ```json
-        {
+{
-            "name": "Bench Console",
+  "name": "Bench Console",
-            "type": "python",
+  "type": "python",
-            "request": "launch",
+  "request": "launch",
-            "program": "${workspaceFolder}/frappe-bench/apps/frappe/frappe/utils/bench_helper.py",
+  "program": "${workspaceFolder}/frappe-bench/apps/frappe/frappe/utils/bench_helper.py",
-            "args": [
+  "args": ["frappe", "--site", "mysite.localhost", "console"],
-                "frappe", "--site", "mysite.localhost", "console"
+  "pythonPath": "${workspaceFolder}/frappe-bench/env/bin/python",
-            ],
+  "cwd": "${workspaceFolder}/frappe-bench/sites",
-            "pythonPath": "${workspaceFolder}/frappe-bench/env/bin/python",
+  "env": {
-            "cwd": "${workspaceFolder}/frappe-bench/sites",
+    "DEV_SERVER": "1"
-            "env": {
+  }
-                "DEV_SERVER": "1"
+}
-            }
-        }
 ```

docs/connect-to-localhost-services-from-containers-for-local-app-development.md

@@ -2,9 +2,9 @@ Not using separate container
 Add following to frappe container from the `.devcontainer/docker-compose.yml`:
 
 ```yaml
-    extra_hosts:
+extra_hosts:
-      app1.localhost: 172.17.0.1
+  app1.localhost: 172.17.0.1
-      app2.localhost: 172.17.0.1
+  app2.localhost: 172.17.0.1
 ```
 
 This is makes the domain names `app1.localhost` and `app2.localhost` connect to docker host and connect to services running on `localhost`.

docs/docker-swarm.md

@@ -45,6 +45,7 @@ Commands explained:
 - `yq eval ".\"networks\"={\"traefik-public\":{\"external\":true}}"`, this commands adds external network `traefik-public` to the stack
 
 Notes:
+
 - Set `BENCH_SUFFIX` to the stack name. the stack will be located at `~/gitops/compose-${BENCH_SUFFIX}.yaml`.
 - `traefik-public` is assumed to be the network for traefik loadbalancer for swarm.
 - Once the stack YAML is generated, you can edit it further for advance setup and commit it to your gitops

docs/setup-options.md

@@ -52,6 +52,7 @@ docker-compose -f compose.yaml \
 # Start containers
 docker-compose --project <project-name> -f ~/gitops/docker-compose.yml up -d
 ```
+
 ### Setup ERPNext using containerized MariaDB and Redis with Letsencrypt certificates.
 
 ```sh