[openstack-dev] [docs][all] Front page template for project team documentation
pkovar at redhat.com
Thu Jul 19 15:55:29 UTC 2018
A spin-off discussion in https://review.openstack.org/#/c/579177/ resulted
in an idea to update our RST conventions for headings level 2 and 3 so that
our guidelines follow recommendations from
The updated conventions also better reflect what most projects have been
using already, regardless of what was previously in our conventions.
To sum up, for headings level 2, use dashes:
For headings level 3, use tildes:
For details on the change, see:
On Fri, 29 Jun 2018 16:45:53 +0200
Petr Kovar <pkovar at redhat.com> wrote:
> Hi all,
> Feedback from the Queens PTG included requests for the Documentation
> Project to provide guidance and recommendations on how to structure common
> content typically found on the front page for project team docs, located at
> doc/source/index.rst in the project team repository.
> I've created a new docs spec, proposing a template to be used by project
> teams, and would like to ask the OpenStack community and, specifically, the
> project teams, to take a look, submit feedback on the spec, share
> comments, ideas, or concerns:
> The main goal of providing and using this template is to make it easier for
> users to find, navigate, and consume project team documentation, and for
> contributors to set up and maintain the project team docs.
> The template would also serve as the basis for one of the future governance
> docs tags, which is a long-term plan for the docs team.
> Thank you,
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
More information about the OpenStack-dev