Bug 1295621

Assigning to Radek for review.

Radek - see the instructions for how to generate this guide, but feel free to reach out to Don or myself if you run into any issues along the way!

Preview: http://lacrosse.corp.redhat.com/~rbiba/doc-preview/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/doc-CLI_Reference/

(Looooong commit: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/commit/aae057e31ba33d03f10eade91927933b953d571a )

I added a couple of other commits and updated the HTML preview:

http://lacrosse.corp.redhat.com/~rbiba/doc-preview/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/doc-CLI_Reference/

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/commits/BZ%231295621

Ready for QA.

A couple of issues:

* The title of the Gnocchi section. In https://wiki.openstack.org/wiki/Gnocchi, the project is referred to as "TDBaaS (Time Series Database as a Service)".

* In the TOC, "Image service command-line client" is Chapter 8, and the next chapter is "Image Service property keys", which is Chapter 10. If you click on the TOC link to the latter, it takes you to "Chapter 9. Image Service property keys", which is followed by a "Chapter 10. Image Service property keys" that looks like it has identical content.

I suspect that the second one is a build issue, but I thought to point it out anyway.

(In reply to Don Domingo from comment #5)
> A couple of issues:
> 
> * The title of the Gnocchi section. In
> https://wiki.openstack.org/wiki/Gnocchi, the project is referred to as
> "TDBaaS (Time Series Database as a Service)".

The original title is hard coded in os_doc_tools/resources/clients.yaml. I've changed it in the XML, but it should probably be changed in the code as well.

> * In the TOC, "Image service command-line client" is Chapter 8, and the next
> chapter is "Image Service property keys", which is Chapter 10. If you click
> on the TOC link to the latter, it takes you to "Chapter 9. Image Service
> property keys", which is followed by a "Chapter 10. Image Service property
> keys" that looks like it has identical content.
> 
> I suspect that the second one is a build issue, but I thought to point it
> out anyway.

The problem was partly here:

 doc-CLI_Reference]$ grep -r ch_cli_glance_property_keys.xml en-US/
en-US/bk-cli-reference.xml:    <xi:include href="ch_cli_glance_property_keys.xml"/>
en-US/autogen/ch_cli_glance_commands.xml:    <xi:include href="../ch_cli_glance_property_keys.xml"/>

And partly the fact that it was a chapter. I converted it into a section (8.5 under Glance) and disabled the double inclusion of the file:

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/commit/111c2f91922e160c06c96ac16588cd84b6fd20b8

Please reload http://lacrosse.corp.redhat.com/~rbiba/doc-preview/docs-Red_Hat_Enterprise_Linux_OpenStack_Platform/doc-CLI_Reference/ to get the new revision.

Is that better?

Thanks!

That looks better, I don't see any further problems with the doc.

This content is now live on the Customer Portal.

Closing.