admin cloud guide: networking advanced features rendering could be improved

[Gauvain Pocentek]

The examples of this section don't use the same organisation, sometimes it's a table, sometimes it's a list. Using lists everywhere would probably improve the global aspect of pages (lists are used almost everywhere in the doc for command line examples).

Also some commands are very long and should be split on multiple lines.

[Gauvain Pocentek (gpocentek)]

http://docs.openstack.org/admin-guide-cloud/content/section_networking-adv-features.html

[Alexandra Settle (alexandra-settle)]

Gauvain, just a minor clarification point. Checking that when you say list you're referring to something like this: http://docs.openstack.org/admin-guide-cloud/content/section_allowed_address_pairs_workflow.html
VS.
An example table like this: http://docs.openstack.org/admin-guide-cloud/content/provider_api_workflow.html

[Gauvain Pocentek (gpocentek)]

Alexandra: exactly. Thank you for taking care of this :)

[Alexandra Settle (alexandra-settle)]

Gauvain, I had a proper look through the chapter and it's sitting at nearly 85% tables, and to be completely honest I think it looks better with the tables as opposed to the list, regardless of the fact the rest of the book is in lists. (It seems cleaner, and easy to read).

I'm dubious about changing the way it looks at the moment, but that's just my opinion. If someone has a second/third opinion on top of mine, that'd be great.

[Gauvain Pocentek (gpocentek)]

Hi Alexandra,

I suggested to remove the tables because there's not a lot of those in the entire doc (for code samples).

Some tables are not easy to read on relatively small screens (http://docs.openstack.org/admin-guide-cloud/content/lbaas_workflow.html for instance).

I'm not against keeping the table, but at least having consistency and proper rendering would be nice :)

Thanks!

[Lana (loquacity)]

I agree that a lot of these tables should remain as is. However, the two column tables that contain commands (such as http://docs.openstack.org/admin-guide-cloud/content/provider_api_workflow.html) would probably work better as lists. Alex, can we get those ones flipped over, and then take another look? Just do a patch and mark it as Partial-Bug: #1290447

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/87437

[Alexandra Settle (alexandra-settle)]

Gauvain/Lana,

Here is a partial patch for this bug: https://review.openstack.org/#/c/87437/

Take a look, please review and comment.

Thanks,

Alex

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/87437
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=f5af263db13644db09e50418db13d27992631fd8
Submitter: Jenkins
Branch: master

commit f5af263db13644db09e50418db13d27992631fd8
Author: Alexandra Settle <email address hidden>
Date: Tue Apr 15 12:48:12 2014 +1000

    Update from tables to list structure in Cloud Admin Guide

    Updated 'Basic Load-Balancer-as-a-Service Operations'and 'Provider extension API operations' sections to be a list instead of a table.

    Partial bug: #1290447

    Change-Id: I2ce247cc0893e9d499c9452ba3c9cb897beb0ed9

[Alexandra Settle (alexandra-settle)]

Gauvain were you happy with how this looks now? Were there any further changes? I can't remember exactly why this was marked a partial and not a close.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/121430

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/121430
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=627590673ab7729ffbd9a031d3248220364011e2
Submitter: Jenkins
Branch: master

commit 627590673ab7729ffbd9a031d3248220364011e2
Author: Alexandra Settle <email address hidden>
Date: Mon Sep 15 11:05:55 2014 +1000

    Indenting line of code

    Indenting line of code to improve readability

    Change-Id: Id3945a157e13048e68b590f6a2dbd3f12b5c9f83
    Closes-Bug: #1290447

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.