[Openstack-docs] Proposal: CLI Reference manual

Steve Gordon sgordon at redhat.com
Thu Jan 30 15:05:48 UTC 2014


----- Original Message -----
> From: "Diane Fleming" <diane.fleming at RACKSPACE.COM>
> To: "Andreas Jaeger" <aj at suse.com>, openstack-docs at lists.openstack.org
> Sent: Thursday, January 30, 2014 9:53:48 AM
> Subject: Re: [Openstack-docs] Proposal: CLI Reference manual
> 
> Andreas,
> 
> After looking at the new CLI reference, I'm okay with having it as a
> separate book and removing the appendices from the End User Guide and
> Admin User Guide.
>
> However, I do think we could do more work to improve the formatting of the
> Command Reference - I can suggest a format for the output. That will
> involve more coding work, but I think it would be worth it.
>
> However, for the time being, this is still a huge improvement, so I think
> we should push through the current version.
>
> The enhanced command reference is 200 pages, so it's probably best to
> remove it from the user guides, and provide pointers from those guides to
> the new Command Reference.
> 
> So I recommend:
> 
> 1. Update Command Reference to use same ch_cli.xml file as End User Guide,
> with conditions to omit unneeded content.
>    Then, push through current version of Command Reference. One version
> (trunk), and no release-centric versions.
> 2. Remove appendices from user guides, and include pointers to new Command
> Reference. However, leave the ch_cli.xml as is in both those books.
>    (Don't remove installation    instructions for CLIs.)
> 3. New bug to improve formatting in Command Reference.
> 
> My two cents!

+1 to all of the above from my side.

Thanks,

Steve



More information about the Openstack-docs mailing list