openstack-doc-core team mailing list archive

[Lana Brindley <openstack@xxxxxxxxxxxxxxxx>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 01/07/15 22:47, Anne Gentle wrote:
> On Wed, Jun 24, 2015 at 9:03 PM, Lana Brindley <openstack@xxxxxxxxxxxxxxxx>
> wrote:
> 

<snip>

>> 3: We adjust docimpact to raise a bug in their own dev repo. So, patch
>> against swift with docimpact raises a bug in the swift bug queue, not the
>> openstack-manuals doc queue. Maintenance overhead then remains with dev,
>> and I bet you any money they would self-police that better than we ever
>> could.
>>
> 
> This is the direction I envisioned, but let's talk through it a little more
> for some of the larger projects. For example, a DocImpact patch that
> affects the config ref for nova, how do we track that it's complete if it's
> logged against nova? There are probably ways to handle this, and
> Launchpad's API could help. It just involves more coordination at release
> time for release-sensitive DocImpact.
> 

+1

> 
>>
>> 4: Some other thing I haven’t thought of yet … ?
>>
> 
> For the API Working Group, APIImpact is a flag that becomes a review
> request and not a bug. At each weekly meeting, they have an agenda item to
> review patches with APIImpact. This helps the developers get a better
> patch, ensures API consumers are protected, and lets the API working group
> consider whether guidelines are already in place or need to be written in
> order to accurately review the patch. I'd like to see this approach
> included in our process (even if we are "way behind" in numbers).

Yep, I like this idea, too.

> 
> So, my proposal would be a combination:
>  - keep DocImpact
>  - use DocImpact for reviews both at weekly meetings and in day-to-day
> review dashboards
>  - log bugs with DocImpact against the product with a way to aggregate at
> release time
> 
> Might need a small spec, perhaps in openstack-specs, to make sure we
> communicate the chosen approach widely. Also that lets you easily bring it
> up at a cross-project meeting.

Agreed. I'll get that done, probably early next week.

> 
> If you like, I can create a new docs dashboard that contains
> DocImpact-flagged patches. Let me know your thoughts.

That'd be great, thanks!

L

- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVlGhHAAoJELppzVb4+KUyhrAH/1jPg1rqYygYKnQcL0X7WQ/5
a09kV6nHL/l7Vm+4yT6z/yRLZfWUi4JXap7Cu/ZMnWZ+/ojLwnKyPnaGfjIs751b
A+o60/M7OxzGAHYySrksDdNsES/PCeeuLfBLQ03kG0mySCIWJHDSggBx2iI916fg
hX3rGqIlcDuPo87rLuSn/ltTmFZr8GscFvv8AySXd7weoEEaEV+rlEB0aHH57uFB
hpyp75stjMZIAtpwWI3451sxFDYMujD/kPstnaIaJzUw6hwRX51JaBVGsQGNUMFN
PodPIeCVyzR4B763KYZlbYnLSuHnSo5YRxQCXgAdgUF4aVH2VUKsa+0N9nPmubs=
=BtaN
-----END PGP SIGNATURE-----