Docs: Use the correct YAML text block indicator to prevent formatting issues

[neodon]

In the Spark Quickstart guide, the initial docker-compose example specifies an entrypoint script in a multi-line string. The string is mistakenly started with the 'folded style' indicator >, which causes formatters to collapse it into one line.

Changing to the 'literal style' indicator | resolves the issue and preserves formatting.

Folded Style: https://yaml.org/spec/1.2.2/#813-folded-style
Literal Style: https://yaml.org/spec/1.2.2/#812-literal-style

[neodon]

Pardon the (probably) unnecessary merge.

[hussein-awala]

Indeed, > collapses the code into one line, but do we need one or multi-line here? IMHO it's one line because it's one command (/bin/sh -c "...")

[neodon]

I tend to agree with you on "one line for one command". In this case, however, there is one outer command that contains multiple inner commands. So applying your criteria, would the inner commands be on separate lines?

There's also the issue of readability when my editor tries to format it. With >, it doesn't change anything because the overall value is a valid multiline block. With | and formatting, though, it becomes:

/bin/sh -c "      until (/usr/bin/mc config host add minio http://minio:9000 admin password) do echo '...waiting...' && sleep 1; done;      /usr/bin/mc rm -r --force minio/warehouse;      /usr/bin/mc mb minio/warehouse;      /usr/bin/mc policy set public minio/warehouse;      tail -f /dev/null      "

I have trouble following that result. I have to work around the problem somehow and fight my editor to keep it from changing that line. It's not a concern for everyone, but most of my projects use format-on-save.

Edit: I hope I understood your point correctly. I'll add that the block is still a valid entrypoint script and runs successfully when multiline.