Add markdown linting (without breaking the site this time!)

This commit is contained in:
David Young authored and GitHub committed 2021-10-21 17:53:15 +13:00
1 parent 52460b8ead
commit 22293fa93d
131 files changed
+668 -1361

No files matched your search

+3 -3
View File
@@ -16,7 +16,7 @@ The ansible playbooks / roles in premix are intended to automate the deployment
## Details
**Duplication should be avoided**
### Duplication should be avoided
This means that ansible will use the same source files which we use to deploy swarm stacks manually (*i.e., /kanboard/*). This has some implications:
@@ -26,7 +26,7 @@ This means that ansible will use the same source files which we use to deploy sw
In an ansible-based deployment, we **don't** clone the premix repo to /var/data/config. Instead, we clone it somewhere local, and then use the playbook to launch the stack, including the creation of ceph shared storage at /var/data/config. The necessary files are then **copied** from the cloned repo into `/var/data/config`, so that they can be altered by the user, backed up, etc. This separation of code from config makes it easier for users to pull down updates to the premix repo, without having to worry about merge conflicts etc for the files they've manually changed during deployment.
**Configuration should be centralized**
### Configuration should be centralized
What we _don't_ want, is to manually be editing `<recipe>/<recipe>.env` files all over, and tracking changes to all of these. To this end, there's a `config` dictionary defined, which includes a subsection for each recipe. Here's an example:
@@ -43,4 +43,4 @@ config:
AWS_ACCESS_KEY_ID: {{ "{{ vault_config.traefik.aws_access_key_id }}" }}
AWS_SECRET_ACCESS_KEY: {{ "{{ vault_config.traefik.aws_secret_access_key }}" }}
AWS_REGION: ""
```
```