tracker issue : CF-4205229

On the Docker image help page (https://helpx.adobe.com/coldfusion/using/docker-images-coldfusion.html), there are a few errors. (I also have some suggestions. I'll post them in a separate entry.)

Before I share the feedback, let me say first that the page is indeed very helpful. I'm simply proposing some things that are in error that could confuse users, so should be fixed. Thanks.

1) First, a line near top mentions:

"Standalone - docker pull eaps-docker-coldfusion.bintray.io/cf/standalone:latest"

That is incorrect. There is no "standalone" image name. Both references to it in that line should be changed to "coldfusion", as in:

"ColdFusion - docker pull eaps-docker-coldfusion.bintray.io/cf/coldfusion:latest"

2) Under "Run ColdFusion image in daemon mode", it shows:

"To view a lost of all running containers, enter:
			* 
docker ps -a"

That is incorrect on two points. It should be "list" not "lost", and it should refer to viewing  "running or stopped" containers, since it shows using the -a arg to ps:

"To view a list of all stopped or running containers, enter"

3) Under "environment variables" (the first section discussing those, about the CF image), the list of them is preceded by a heading "env file", which doesn't make sense yet, as env files have not been mentioned on the page to this point. There's simply no reason for the heading to be "env file".

4) Note that first list of env vars (under that previous heading) does not show the "serial" and "previousSerial" env vars, whic were added in 2018.0.2 and above.

Curiously, the page DOES list them in the next subheading, "Pass the serial key as environment variable".

5)  And in that "Pass the serial key as environment variable" subsection, why is a coldfusion.env shown, when again it has not yet been referred to on the page? (It will be used, and shown separately, after the docker-compose.yml shown in the next section.) The exisitng sub-heading of "environment variables" would be sufficient.

6) More important, under a later "environment variables" section (this time, about the add-ons image). it mistakenly lists the env vars for CF images. as being those for the add-ons image, which is of course incorrect. They should be shown as:

acceptEULA=YES
solrUsername=<SOLR-USERNAME>
solrPassword=<SOLR-PASSWORD>

7) Also, while we're on this set of env vars (for the add-ons), note that it too lists them under a subsection heading of "coldfusion.env", but here there is no use of such an env file (for the add-ons image) in the page. Here again, the heading above it for "environment variables" would be sufficient.

8) More important, this list of the env vars (intended to show those for the add-ons image) shows them instead with demo values, rather than with the explanation of what they are about, as was done for the CF image env vars when they were introduced on the page.

9) And why not precede these with the cmd to run the image to get help, as was shown for the CF image above? It would be:

docker run --rm eaps-docker-coldfusion.bintray.io/cf/addons:latest help

Attachments:

Comments: