[OpenStack-docs] Api Ref links/openstackdocs theme
kbhawkey at gmail.com
Fri Jun 17 15:15:57 UTC 2016
I've been thinking about how to present the API References/Guides from
developer.openstack.org and how to customize components from the
openstackdocstheme for the API References/Guides.
So far, two options come to mind for updating developer.openstack.org:
-Add links (add new icons for each service?) to developer.openstack.org for
each published API Reference and Guide. I think this is preferred as all
references are displayed at the same time.
-Add a single drop down menu, listing the APIs/Guides.
Customizing openstackdocstheme library:
- Add new drop down menu which lists the published api references and
guides, replacing the current sidebartoc. This menu is configurable.
- Add new navigation bar near/replacing existing next/prev/bug navigation
The new navigation bar could contain links to the developer docs/the
guide for this service/what's on this page/bug input. Also
Some initial work at, https://review.openstack.org/#/c/329508
Some remaining questions about how to get a link to the content of the
latest published api references/guides. I imagine it would be best if the
build of the osdocstheme library was not coupled with a static list of
How can/should this list be generated to manage the published references?
Also, each published API Reference could build with the openstackdocstheme
so that the references,
1) look similar
2) have a menu to toggle between references
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-docs