<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#FFFFFF">
Thanks for the cleanup bugs, Anne! Will definitely use for editing
work going forward:)<br>
<br>
cheers, Summer<br>
<br>
<div class="moz-signature">
<div><font color="#666666">Summer Long<br>
OpenStack Documentation<br>
Engineering Content Services<br>
<br>
Red Hat Asia Pacific<br>
Brisbane, Australia</font><br>
<a href="mailto:slong@redhat.com">slong@redhat.com</a></div>
</div>
<br>
<span style="color:#000000;" class="headerSpan">
<div class="moz-cite-prefix">On 08/29/2013 07:38 AM, Anne Gentle
wrote:<br>
</div>
</span>
<blockquote
cite="mid:CAD0KtVFZ2WCsiVCyb5oAg0Xf_8V9HTVHapKx2okdo1ofLQ9DsQ@mail.gmail.com"
type="cite">
<div dir="ltr">All,
<div><br>
</div>
<div>I've been drafting this for the wiki this week, and wanted
to ensure I'm capturing our current thinking on review
guidelines and processes for documentation. A few questions
have come up recently that I hope these guidelines address.
Let me know your thoughts. </div>
<div><br>
</div>
<div>
<div><br>
</div>
<div>=== Reviewer Guidelines ===</div>
<div><br>
</div>
<div>We do not currently require a bug to be linked from every
doc patch submission in order to consider it for review.
While many OpenStack projects associate every commit to
either a bug ID or blueprint name, documentation does not
have this strict requirement due to the balancing act
between disciplined doc work and ensuring that too much
process doesn't get in the way of making docs fixes quickly.</div>
<div><br>
</div>
<div>While generally we do want doc bugs for feature work, as
a team we haven't been super strict about a bug for each
patch. That said, we do have this ongoing bug: <a
moz-do-not-send="true"
href="https://bugs.launchpad.net/openstack-manuals/+bug/1121866">https://bugs.launchpad.net/openstack-manuals/+bug/1121866</a>
for cleanup to match the OpenStack Conventions documented at
<a moz-do-not-send="true"
href="https://wiki.openstack.org/wiki/Documentation/Conventions">https://wiki.openstack.org/wiki/Documentation/Conventions</a>.
We also have <a moz-do-not-send="true"
href="https://bugs.launchpad.net/openstack-manuals/+bug/1217503">https://bugs.launchpad.net/openstack-manuals/+bug/1217503</a>
for ongoing markup changes to match our conventions. These
bugs can be used for cleanup work related to conventions.</div>
<div><br>
</div>
<div>We have to make a judgement call about super-fine-grained
inclusions (where you xi:include content below a
<section> or <chapter> level. Sometimes reuse is
not the best solution and rewriting the content would be
better. Sometimes reuse is the right solution and you should
rewrite something generically for re-use in multiple places.
With many contributors looking at the repo for the first
time, it's a fine line to walk, so reviewers need to ensure
we use good judgement on reuse thinking of ongoing
maintenance.</div>
<div><br>
</div>
</div>
<div>------------------</div>
<div><br>
</div>
<div>Any other guidelines to capture?</div>
<div>Thanks,</div>
<div>Anne</div>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
Openstack-docs mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a>
<a class="moz-txt-link-freetext" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a>
</pre>
</blockquote>
<br>
</body>
</html>