[OpenStack-docs] [openstack-doc] ToC arrangement

Alexandra Settle a.settle at outlook.com
Thu Mar 30 10:11:19 UTC 2017


Makes sense. We can do that by removing the title headings on the index page.

Commented here: https://review.openstack.org/#/c/450084/10/doc/arch-design/source/index.rst

What does everyone think of the new format?

From: Darren Chan <dazzachan at yahoo.com.au>
Reply-To: "dazzachan at yahoo.com.au" <dazzachan at yahoo.com.au>
Date: Thursday, March 30, 2017 at 12:14 AM
To: Alexandra Settle <a.settle at outlook.com>, Andreas Jaeger <aj at suse.com>, "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org>
Cc: "Darren Chan (AU)" <darren.chan at RACKSPACE.COM>
Subject: Re: [OpenStack-docs] [openstack-doc] ToC arrangement


Yep.

On 29/3/17 8:59 pm, Alexandra Settle wrote:
I like it: http://docs-draft.openstack.org/84/450084/7/check/gate-openstack-manuals-tox-doc-publish-checkbuild/7f04cac//publish-docs/ops-guide/index.html<http://docs-draft.openstack.org/84/450084/7/check/gate-openstack-manuals-tox-doc-publish-checkbuild/7f04cac/publish-docs/ops-guide/index.html> builds nice!

Do you mean the Abstract and Contents links?


From: Darren Chan <dazzachan at yahoo.com.au><mailto:dazzachan at yahoo.com.au>
Reply-To: "dazzachan at yahoo.com.au"<mailto:dazzachan at yahoo.com.au> <dazzachan at yahoo.com.au><mailto:dazzachan at yahoo.com.au>
Date: Tuesday, March 28, 2017 at 11:26 PM
To: Alexandra Settle <a.settle at outlook.com><mailto:a.settle at outlook.com>, Andreas Jaeger <aj at suse.com><mailto:aj at suse.com>, "openstack-docs at lists.openstack.org"<mailto:openstack-docs at lists.openstack.org> <openstack-docs at lists.openstack.org><mailto:openstack-docs at lists.openstack.org>
Cc: "Darren Chan (AU)" <darren.chan at RACKSPACE.COM><mailto:darren.chan at RACKSPACE.COM>
Subject: Re: [OpenStack-docs] [openstack-doc] ToC arrangement


Thanks Alex. I have a few other suggestions:
·         Remove the search heading and link under the TOC. There's already a search field in the page header.
·         Is there a way to remove or hide the section links at the top of the index page? I don't think it's needed either.

Cheers,

Darren

On 29/3/17 1:03 am, Alexandra Settle wrote:

    If we change it, let's change it everywhere.



    So, make a single change that updates all manuals in openstack-manuals -

    and another one  for security guide and one for the api-site manuals.



    So far, there's no change up to show how it could look otherwise. Why

    not create a WIP change for one guide that just rearranges and show that

    - and then let's discuss more? If everybody is fine, amend and change all..



Using Darren’s patch as an example again: https://review.openstack.org/#/c/450084/



I edited the ops-guide/index file and here’s the build: http://docs-draft.openstack.org/84/450084/6/check/gate-openstack-manuals-tox-doc-publish-checkbuild/79c1a84//publish-docs/ops-guide/index.html<http://docs-draft.openstack.org/84/450084/6/check/gate-openstack-manuals-tox-doc-publish-checkbuild/79c1a84/publish-docs/ops-guide/index.html>



I admit, that’s messy. Probably not what we want. We can edit this… Thoughts overall though?



Alex





_______________________________________________

OpenStack-docs mailing list

OpenStack-docs at lists.openstack.org<mailto:OpenStack-docs at lists.openstack.org>

http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs





-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20170330/f20e0312/attachment-0001.html>


More information about the OpenStack-docs mailing list