[openstack-dev] [docs][all] Front page template for project team documentation

Petr Kovar pkovar at redhat.com
Fri Jun 29 14:45:53 UTC 2018


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:

  https://review.openstack.org/#/c/579177/

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,
pk



More information about the OpenStack-dev mailing list