docs(meta): Better distiguish component_list entry examples

This commit is contained in:
hygienic-books 2023-06-11 23:05:23 +02:00
parent c8e6465ee9
commit 7fb2be86ee

@ -66,7 +66,7 @@ Your four answers translate as follows into rendered files.
└── grafana
...
└── env
└── fully.qualified.domain.name.example <---
└── fqdn_context.env.example <---
```
Which then looks like:
@ -132,7 +132,7 @@ Consider Cookiecutter's project directory and rendered files a starting point. I
Imagine if you will a service that consists of [Infinispan](https://infinispan.org/) among other things. In Docker Hub's content-addressable image store Infinispan's location is at `infinispan/server` so you obviously want that exact string with a forward slash to show up in your `docker-compose.yml` as the `image:` key's value, same with your `Dockerfile`. The `image:` key's value comes from what you enter in Cookiecutter's `component_list` prompt. Component strings are then used to also pre-fill the `volumes:` key.
This will cause obvious issues (but the `image:` key is kinda correct):
_**This**_ will cause obvious issues (but the `image:` key is kinda correct):
```
services:
infinispan/server:
@ -140,7 +140,7 @@ services:
container_name: "cacheman-infinispan/server-${CONTEXT}"
```
This won't cause issues (but you'll have to then go in and manually change the `image:` key to use `infinispan/server`):
_**This**_ won't cause issues (but you'll have to then go in and manually change the `image:` key to use `infinispan/server`):
```
services:
infinispan: