Open Stack

On 01/30/2014 03:53 PM, Diane Fleming wrote:
> 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.

I don't see this directly as feasible, I think it's fine as is.

>    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.

Patches sent.

>    (Don't remove installation    instructions for CLIs.)
> 3. New bug to improve formatting in Command Reference.

Done.


The document is live now on the docs page.

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126