From 3026e3078358a13ff2a8ef0c7321095a90cb60f8 Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Sat, 24 Jun 2023 23:27:59 +0200 Subject: [PATCH] docs(docker-compose): Pepper _FIXME_ markers throughout README.md to clean it prior to commit --- docker-compose/examples/grafana/README.md | 10 ++++++++-- docker-compose/examples/hashicorpvault/README.md | 12 +++++++++--- .../{{ cookiecutter.__project_slug }}/README.md | 12 +++++++++--- 3 files changed, 26 insertions(+), 8 deletions(-) diff --git a/docker-compose/examples/grafana/README.md b/docker-compose/examples/grafana/README.md index 0e9b697..04cb29c 100644 --- a/docker-compose/examples/grafana/README.md +++ b/docker-compose/examples/grafana/README.md @@ -1,6 +1,10 @@ +# _FIXME_ + +Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). + # Grafana Docker Compose files -Docker Compose files to spin up an instance of Grafana. +Docker Compose files to spin up an instance of Grafana _FIXME_ capitalization _FIXME_. # How to run @@ -52,7 +56,7 @@ Create ZFS datasets and set permissions as needed. zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/data/logs' zfs create -p 'zpool/docker-data/grafana-'"${COMPOSE_CTX}"'/nginx/config' ``` - When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). + _FIXME_ delete when all is done _FIXME_ When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). * Create subdirs ``` @@ -68,6 +72,8 @@ Create ZFS datasets and set permissions as needed. Place the following files on target server. Use the directory structure at [build-context](build-context) as a guide, specifically at `docker-data`. +_FIXME_ Add details about files that aren't self-explanatory _FIXME_ + ``` build-context/ ├── grafana diff --git a/docker-compose/examples/hashicorpvault/README.md b/docker-compose/examples/hashicorpvault/README.md index 4abd21c..630bb68 100644 --- a/docker-compose/examples/hashicorpvault/README.md +++ b/docker-compose/examples/hashicorpvault/README.md @@ -1,6 +1,10 @@ +# _FIXME_ + +Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). + # Vault Docker Compose files -Docker Compose files to spin up an instance of Vault. +Docker Compose files to spin up an instance of Vault _FIXME_ capitalization _FIXME_. # How to run @@ -26,7 +30,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full ``` ## Build -We build the `vault` image locally. Our adjustment to the official image is simply adding `/tmp/vault` to it. See [build-context/vault/Dockerfile](build-context/vault/Dockerfile). We use `/tmp/vault` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location. +_FIXME_ We build the `vault` image locally. Our adjustment to the official image is simply adding `/tmp/vault` to it. See [build-context/vault/Dockerfile](build-context/vault/Dockerfile). We use `/tmp/vault` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location. ``` docker compose --project-name "${COMPOSE_PROJECT}" --file "${COMPOSE_FILE}" --file "${COMPOSE_OVERRIDE}" --env-file "${COMPOSE_ENV}" --profile 'build' build @@ -57,7 +61,7 @@ Create ZFS datasets and set permissions as needed. zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/data/logs' zfs create -p 'zpool/docker-data/vault-'"${COMPOSE_CTX}"'/vault/config' ``` - When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). + _FIXME_ delete when all is done _FIXME_ When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). * Create subdirs ``` @@ -73,6 +77,8 @@ Create ZFS datasets and set permissions as needed. Place the following files on target server. Use the directory structure at [build-context](build-context) as a guide, specifically at `docker-data`. +_FIXME_ Add details about files that aren't self-explanatory _FIXME_ + ``` build-context/ ├── docker-data diff --git a/docker-compose/{{ cookiecutter.__project_slug }}/README.md b/docker-compose/{{ cookiecutter.__project_slug }}/README.md index 0edf455..0cc1a19 100644 --- a/docker-compose/{{ cookiecutter.__project_slug }}/README.md +++ b/docker-compose/{{ cookiecutter.__project_slug }}/README.md @@ -1,6 +1,10 @@ +# _FIXME_ + +Search and replace all mentions of _FIXME_ with sensible content in this file and in [docker-compose.yml](docker-compose.yml). + # {{ cookiecutter.__service_slug.capitalize() }} Docker Compose files -Docker Compose files to spin up an instance of {{ cookiecutter.__service_slug.capitalize() }}. +Docker Compose files to spin up an instance of {{ cookiecutter.__service_slug.capitalize() }} _FIXME_ capitalization _FIXME_. # How to run @@ -32,7 +36,7 @@ docker context create fully.qualified.domain.name --docker 'host=ssh://root@full {%- set components = cookiecutter.__component_list_slug.split(',') -%} {% for component in components %} {%- if loop.first %} -We build the `{{ cookiecutter.__service_slug }}` image locally. Our adjustment to the official image is simply adding `/tmp/{{ cookiecutter.__service_slug }}` to it. See [build-context/{{ cookiecutter.__service_slug }}/Dockerfile](build-context/{{ cookiecutter.__service_slug }}/Dockerfile). We use `/tmp/{{ cookiecutter.__service_slug }}` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location. +_FIXME_ We build the `{{ cookiecutter.__service_slug }}` image locally. Our adjustment to the official image is simply adding `/tmp/{{ cookiecutter.__service_slug }}` to it. See [build-context/{{ cookiecutter.__service_slug }}/Dockerfile](build-context/{{ cookiecutter.__service_slug }}/Dockerfile). We use `/tmp/{{ cookiecutter.__service_slug }}` to bind-mount a dedicated ZFS dataset for the application's `tmpdir` location. {%- endif %} {%- endfor %} @@ -79,7 +83,7 @@ Create ZFS datasets and set permissions as needed. zfs create -p 'zpool/docker-data/{{ cookiecutter.__service_slug }}-'"${COMPOSE_CTX}"'/{{ cookiecutter.__service_slug }}/config' {%- endif %} ``` - When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). + _FIXME_ delete when all is done _FIXME_ When changing bind mount locations to real ones remember to also update `volumes:` in [docker-compose.yml](docker-compose.yml). * Create subdirs ``` @@ -105,6 +109,8 @@ Create ZFS datasets and set permissions as needed. Place the following files on target server. Use the directory structure at [build-context](build-context) as a guide, specifically at `docker-data`. +_FIXME_ Add details about files that aren't self-explanatory _FIXME_ + ``` build-context/ {%- if ',' in cookiecutter.__component_list_slug -%}