azure angle brackets new user trap about docs HOT 5 CLOSED

Hi, thanks for the report. The problem is that No bracket style is universal, and they ({[<>]}) all often conflict with other real options or other practice. Would it help if they were coloured differently (tricky actually for visually impaired), or would it suffice to make the comment clearer?

from docs.

As a first-time user I opened the environmnets.yaml file in vi, searched for the azure block, and started filling in the required credentials. The immediately adjacent field, for the pem file, did not have angle brackets and the comment is way up at the top.

Sure, I recognize the convention from command line syntax documentation but I don't often see it in configuration files.

I was thinking maybe just add another note to the azure help page but a worked example would be better. Though honestly, I don't know why the generated yaml has brackets on that one dummy value and not on the others. Perhaps that would be a better place to fix it.

from docs.

I'll take a look at it tomorrow and let you know when a revised version is
up. i think the inconsistency is down to many of the pages and updates
being updated by various different people, we need to curate the
contributions better.

On Mon, Oct 13, 2014 at 7:52 PM, Stephen W. Nuchia <[email protected]

wrote:

As a first-time user I opened the environmnets.yaml file in vi, searched
for the azure block, and started filling in the required credentials. The
immediately adjacent field, for the pem file, did not have angle brackets
and the comment is way up at the top.

Sure, I recognize the convention from command line syntax documentation
but I don't often see it in configuration files.

I was thinking maybe just add another note to the azure help page but a
worked example would be better. Though honestly, I don't know why the
generated yaml has brackets on that one dummy value and not on the others.
Perhaps that would be a better place to fix it.

—
Reply to this email directly or view it on GitHub
#198 (comment).

Nick Veitch
[email protected]

from docs.

I have also filed https://bugs.launchpad.net/juju-core/+bug/1381289

from docs.

cool, I was going to fix that too :)

On Wed, Oct 15, 2014 at 2:49 AM, Andrew Wilkins [email protected]
wrote:

I have also filed https://bugs.launchpad.net/juju-core/+bug/1381289

—
Reply to this email directly or view it on GitHub
#198 (comment).

Nick Veitch
[email protected]

from docs.