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

Steven Dake (stdake) stdake at cisco.com
Mon Apr 11 08:50:02 UTC 2016

On 4/11/16, 1:38 AM, "Gerard Braad" <me at gbraad.nl> wrote:

>On Mon, Apr 11, 2016 at 4:20 PM, Steven Dake (stdake) <stdake at cisco.com>
>> On 4/11/16, 12:54 AM, "Gerard Braad" <me at gbraad.nl> wrote:
>> as
>>>at the moment getting an environment up-and-running according to the
>>>quickstart guide is a hit and miss
>> I don't think deployment is not hit or miss as long as the QSG are
>> followed to a T :)
>Maybe saying "at the moment" was incorrect. As the deployment
>according to the QSG has been a few weeks ago. Sorry about this... as
>you guys have put a lot of effort into it recently.
>> I agree we need more clarity in what belongs in the QSG.
>This can be a separate discussion (Not intending to hijack this thread).
>I am not a core reviewer, but I keep it as-is. I do not see a need for

Even though your not a core reviewer, your comments are valued.  The
reason I addressed core reviewers specifically as they have +2 permissions
and I would like more leniency on new documentation in other files outside
those listed above (philosophy document, QSG) with a pubic statement of

>a lower-bar. Although, documentation is the entry-point into a
>community (as user and potential contributor) and therefore it should
>be of a high quality. Maybe I would be to provide more suggestions
>instead of just indication of 'change this for that'.

The issue I see with our QSG is it has the highest bar for review passage
of any file in the repository.  Any QSG change typically requires 10 or
more patch sets to make it through the core reviewer gauntlet.  This
discourages people from writing new documentation.  I don't want this to
carry over into other parts of the documentation that are as of yet
unwritten.  I'd like new documentation to be ok with misspellings, grammar
errors, formatting problems, ESL authors, and that sort of thing.

The QSG should tolerate none of these types of errors at this point - it
must be absolutely perfect (at least in English:) as to not cause
confusion to new operators.


>OpenStack Development Mailing List (not for usage questions)
>Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe

More information about the OpenStack-dev mailing list