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

Gauvain Pocentek gauvain.pocentek at objectif-libre.com
Tue Mar 28 10:15:12 UTC 2017


Hi all,

Le 2017-03-28 11:32, Alexandra Settle a écrit :
> Hey team,
> 
> Is there any historical reason why we separate our index pages into
> _Content_, _Appendix,_ _Glossary, Search_ rather than having one ToC?
> For example: https://docs.openstack.org/admin-guide/ [1]
> 
> Darren Chan proposed an Arch Guide patch
> (https://review.openstack.org/#/c/450084/) [2] where a discussion was
> brought up about it.
> 
> Quoting Darren, “Because visually, it looks terrible. Why can't we
> integrate those sections in one toctree?”

I've had the same reaction with the ops guide.

> 
> I completely agree. But if there’s a reason we arranged it as such,
> would be really interested to know!

Same here.

Also, could we have 'appendix' and 'glossary' explicitly listed in the 
toc? Because otherwise appendix sections might appear as content 
sections.

Thanks,
Gauvain




More information about the OpenStack-docs mailing list