Open Stack

I'm the one who doesn't like merged user input and computer output
screens! 

But I'm willing to go along with the consensus on this. And I totally
agree that we need to have one convention that we all use.

But here's why I like two screens:

1. You can insert text between the user input and the computer output,
such an explanation of what the user might see in the output.
2. It's clearer to me which is the input and what's the output.
3. For those who want to cut & paste the sample commands, it's clear
exactly what that is - I.e., where the cut-off between the input and
output is.

But have at it!


Here are some examples of each style:

split screens:

http://docs.openstack.org/user-guide/content/cli_networks.html

joined screens:

http://docs.openstack.org/user-guide/content/ceilometer_cli_commands.html


Diane
----------------------------------------------
Diane Fleming
Software Developer II - US

diane.fleming at rackspace.com
Cell  512.323.6799
Office 512.874.1260
Skype drfleming0227
Google-plus diane.fleming at gmail.com






On 3/20/14 3:16 PM, "Gauvain Pocentek"
<gauvain.pocentek at objectif-libre.com> wrote:

>Hi all,
>
>It's been a while since the last convention question, so here goes...
>;)
>
>I suggested to use only one <screen> for multiple command lines in
>https://review.openstack.org/#/c/81579
>I believe this is the way to go but there doesn't seem to be a clearly
>defined convention about this. Anyone opposed to this?
>
>Also, I usually suggest in reviews to include the <userinput> and the
><computeroutput> in the same <screen>. I know that some people (you know
>who you are!) don't really like it, because it is not clear what is to
>be typed and what is the output. Personally I prefer to use a unique
><screen> because the HTML rendering looks better this way.
>
>Andreas just mentioned on IRC that most of our docs use one wrapping
>screen. Do we agree that we should keep this choice, and update the
>"bogus" occurrences?
>
>And is this case, would it be possible to modify the rendering to make
>the distinction between input and output clearer?
>
>Thanks!
>
>Gauvain Pocentek
>
>Objectif Libre - Infrastructure et Formations Linux
>http://www.objectif-libre.com
>
>_______________________________________________
>Openstack-docs mailing list
>Openstack-docs at lists.openstack.org
>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs