[openstack-dev] [kolla][vote] Nit-picking documentation changes

Vikram Hosakote (vhosakot) vhosakot at cisco.com
Wed Apr 13 00:45:15 UTC 2016


I value the friendliness and approachability that contributors seek.

I am totally fine with minor mistakes in documentation.

As they make more changes, they will understand/follow the process.

+1


Regards,
Vikram Hosakote
IRC: vhosakot

From: "Steven Dake (stdake)" <stdake at cisco.com<mailto:stdake at cisco.com>>
Reply-To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Date: Monday, April 11, 2016 at 3:37 AM
To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org<mailto:openstack-dev at lists.openstack.org>>
Subject: [openstack-dev] [kolla][vote] Nit-picking documentation changes

Hey folks,

The reviewers in Kolla tend to nit-pick the quickstart guide to death during reviews.  I'd like to keep that high bar in place for the QSG, because it is our most important piece of documentation at present.  However, when new contributors see the nitpicking going on in reviews, I think they may get discouraged about writing documentation for other parts of Kolla.

I'd prefer if the core reviewers held a lower bar for docs not related to the philosophy or quiickstart guide document.  We can always iterate on these new documents (like the operator guide) to improve them and raise the bar on their quality over time, as we have done with the quickstart guide.  That way contributors don't feel nitpicked to death and avoid improving the documentation.

If you are a core reveiwer and agree with this approach please +1, if not please -1.

This is an unofficial vote and carries no commitment from the core reviewers, but I've included vote in the subject just to catch people's attention and to get folks thoughts on this matter.

Regards
-steve


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160413/3abdde21/attachment.html>


More information about the OpenStack-dev mailing list