[all][PTL][tc] U Community Goal: Project PTL & Contrib Docs Update #3

Kendall Nelson kennelson11 at gmail.com
Mon Feb 24 19:44:08 UTC 2020


There is some debate about where the content of the actual docs should
live. This grew out of the discussion about how to setup the includes so
that the correct info shows up where we want it. 'Correct' in that last
sentence being where the debate is. There are two main schools of thought:

   1. All the content of the docs should live in the top level
CONTRIBUTING.rst and the sphinx glue should live in
doc/source/contributor/contributing.rst. A patch has already been merged
for this approach[1]. There is also a patch to update the goal to match[2].
This approach keeps all the info in one place so that if things change in
the future, its easier to keep things straight. All the content is also
more easily discoverable when looking at a repo in GitHub (or similar) or
checking out the code because it is at the top most level of the repo and
not hidden in the docs sub directory.

    2.  The new patch[3] says that the content should live in
/doc/source/contributor/contributing.rst and a skeleton with only the most
important version should live in the top level CONTRIBUTING.rst. This
approach argues that people don't want to read a wall of text when viewing
the code on GitHub (or similar) or checking it out and looking at the top
level CONTRIBUTING.rst and as such only the important details should be
kept in that file. These important details being that we don't accept
patches in github and where to report bugs (both of which are included in
the larger format of the content).

So what do people think? Which approach do they prefer?

I am anxious to get this settled ASAP so that projects have time to
complete the goal in time.

Previous updates if you missed them[4][5].

Please feel free to add other ideas or make corrections to my summaries of
the approaches if I missed things :)

-Kendall (diablo_rojo)

[1] Merged Template Patch (school of thought 1):
[2] Goal Update Patch: https://review.opendev.org/#/c/707736/
[3] Current Template Patch (school of thought 2):
[4] Update #1:
[5] Update #2:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20200224/d80a7ae7/attachment-0001.html>

More information about the openstack-discuss mailing list