From 3f2ab68adaf1b2b890354934cb4ebc44bd346e2c Mon Sep 17 00:00:00 2001 From: decentral1se Date: Sat, 14 Oct 2023 10:26:22 +0200 Subject: [PATCH] fix: quotes --- docs/federation/resolutions/in-progress/013.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/federation/resolutions/in-progress/013.md b/docs/federation/resolutions/in-progress/013.md index 2adbb322..e9f6c6d7 100644 --- a/docs/federation/resolutions/in-progress/013.md +++ b/docs/federation/resolutions/in-progress/013.md @@ -13,7 +13,7 @@ With this proposal, we would like to address the synchronisation of app deployme ### Details (Budget 007) -We support a config file ($ABRA_DIR/config.yml) which has these defaults: +We support a config file (`$ABRA_DIR/config.yml`) which has these defaults: ```yaml --- @@ -48,23 +48,23 @@ When `abra app deploy/upgrade/rollback/sync` is run, here's what we do: * if there are changes, pull them in & log them * if there is a merge conflict, bail out and ask operator to resolve them -`abra` will search for Git repositories under `$ABRA_DIR/servers/...`. A single Git repository at the root ($ABRA_DIR/servers/.git) and on the individual server level ($ABRA_DIR/servers/example.com/.git) are supported. Both solution work alongside each other and symlinks are resolved. +`abra` will search for Git repositories under `$ABRA_DIR/servers/...`. A single Git repository at the root (`$ABRA_DIR/servers/.git`) and on the individual server level (`$ABRA_DIR/servers/example.com/.git`) are supported. Both solution work alongside each other and symlinks are resolved. -The way to avoid merge conflicts will be to never move the OPERATOR_SYNC_VERSION env var (see below) from the line it is on in the app env config. `abra` will always insert it just under the TYPE env var. +The way to avoid merge conflicts will be to never move the `OPERATOR_SYNC_VERSION` env var (see below) from the line it is on in the app env config. `abra` will always insert it just under the `TYPE` env var. The initial implementation asks operators to initialise their own Git repositories. -2) Read the OPERATOR_SYNC_VERSION env var as the version to deploy / upgrade from / rollback from - * upgrade: if deployed version does not match OPERATOR_SYNC_VERSION, warn before overview +2) Read the `OPERATOR_SYNC_VERSION` env var as the version to deploy / upgrade from / rollback from + * upgrade: if deployed version does not match `OPERATOR_SYNC_VERSION`, warn before overview * rollback: same as above! 3) Run the deployment - * if successful, record a new OPERATOR_SYNC_VERSION, commit & push the changes - * if unsuccessful, do not record a OPERATOR_SYNC_VERSION and ask operator to resolve + * if successful, record a new `OPERATOR_SYNC_VERSION`, commit & push the changes + * if unsuccessful, do not record a `OPERATOR_SYNC_VERSION` and ask operator to resolve -If --chaos is passed, we use the short commit hash instead of the version label. +If `--chaos` is passed, we use the short commit hash instead of the version label. -Here's an example of the OPERATOR_SYNC_VERSION env var: +Here's an example of the `OPERATOR_SYNC_VERSION` env var: ``` # in ~/.abra/servers/example.com/matrix.example.com.env