[OpenStack-docs] devdocs tag in governance

Anne Gentle annegentle at justwriteclick.com
Tue May 24 12:56:01 UTC 2016


Hi all,
At today's TC meeting we'll discuss a patch to discover which projects have
contributor docs. The patchset has some discussion on the value of doc tags
to indicate if a project needs help with docs. There's also some discussion
on the value of doc tags as indicators to the maturity level of the
project.

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

Here's the commit message with some additional outstanding questions:

Adds a docs:devdocs tag to indicate if project publishes devdocs

These are the docs.openstack.org/developer/<project> docs, meant for
contributors to understand and work on the project. Simply uses the Python
requests library to see if URL returns a 200 status code. Need to determine
which URL projects should use for contributor docs as some project names
have a space (like Chef OpenStack). Also not sure what to do with clients
like python-novaclient, should the script also look for those docs? Maybe
those should go in a docs:clidocs tag. Idea is to start with this tag, then
expand to different docs: tags to indicate which projects are more complete
in their doc coverage.

Would appreciate input either on the patch or in the TC meeting [1].
Thanks,
Anne

1. https://wiki.openstack.org/wiki/Meetings/TechnicalCommittee

--
Anne Gentle
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160524/11159ea7/attachment.html>


More information about the OpenStack-docs mailing list