)]}'
{"specs/mitaka/review-docimpact.rst":[{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"2dcfcd216d98fcabfcefd26a236b5c11714c04c0","unresolved":false,"context_lines":[{"line_number":42,"context_line":"that\u0027s 170 new bugs in our queue."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"Proposed change"},{"line_number":45,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"* Adjust ``DocImpact`` so that it cannot be used without a description."},{"line_number":48,"context_line":"  Currently, that is an optional thing contributors can do, but it appears"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_3a175649","line":45,"updated":"2015-09-17 15:34:59.000000000","message":"One bit of the outcome that I\u0027ve been thinking about is this:\n\nDo we want less doc bugs (yes) or do we want more docs placed properly (yes)?\n\nSo what if DocImpact doesn\u0027t log a bug at all but rather indicates that the patch contains docs? We get a yes answer to both the outcomes above.\n\nThis style of commit message then aligns with APIImpact, where the API Working Group reviews incoming patches with that tag. \n\nI know the 170-some backlog of DocImpact tags still means a lot of review work, but the needed goals are then met.\n\nThe changes here would be to the first bullet, where the docs themselves would be in the patch.\n\nThen, the second bullet could change the automation to log bugs elsewhere, but still the problem of \"these bugs aren\u0027t meaningful\" exists, so perhaps stop logging doc bugs as it just punts the problem and spreads the problem to more Launchpad projects. \n\nWhat do you think?","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"56193519d879620b06f348550d6798cea882a71b","unresolved":false,"context_lines":[{"line_number":42,"context_line":"that\u0027s 170 new bugs in our queue."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"Proposed change"},{"line_number":45,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"* Adjust ``DocImpact`` so that it cannot be used without a description."},{"line_number":48,"context_line":"  Currently, that is an optional thing contributors can do, but it appears"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_fc1eaf0a","line":45,"in_reply_to":"ba15a1d1_3a175649","updated":"2015-09-17 21:44:39.000000000","message":"So to be clear: you\u0027re saying a contributor would write some docs, include it in the patch (as an .rst file or similar), and then use DocImpact to indicate it\u0027s there? Then docs need to find these in Gerrit, and add that to the docs? I think if that was the case, we\u0027d still need a bug, but I\u0027d like to enforce the \"don\u0027t add DocImpact unless you already have docs\" thing. That\u0027d be cool. It\u0027s like \"don\u0027t add DocImpact without a description\", but on steroids.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"a154197e5acf03da4b405233940e38758e938663","unresolved":false,"context_lines":[{"line_number":42,"context_line":"that\u0027s 170 new bugs in our queue."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"Proposed change"},{"line_number":45,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"* Adjust ``DocImpact`` so that it cannot be used without a description."},{"line_number":48,"context_line":"  Currently, that is an optional thing contributors can do, but it appears"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_80f1d3cf","line":45,"in_reply_to":"ba15a1d1_fc1eaf0a","updated":"2015-09-22 02:20:54.000000000","message":"Jeremy: do you think it\u0027s possible to enforce this, or are we better off sticking with the description?","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"0e155c82a50dfdcf85fddf7afa25030a6614da66","unresolved":false,"context_lines":[{"line_number":49,"context_line":"  that no one uses it. This would mean that rather than typing \"DocImpact\" and"},{"line_number":50,"context_line":"  moving on with their lives, contributors must write \"DocImpact: Something"},{"line_number":51,"context_line":"  relevant here\". This isn\u0027t foolproof, but it would hopefully encourage"},{"line_number":52,"context_line":"  contributors to think through what they\u0027re actually asking for."},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* Currently, the five defcore projects (Nova, Swift, Keystone, Glance, and"},{"line_number":55,"context_line":"  Cinder) have the DocImpact flag raising bugs automatically into the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_0beb3b79","line":52,"updated":"2015-09-17 11:42:31.000000000","message":"Without the corresponding education campaign (mentioned in your third bullet), the end result will likely be that the majority still have no comment on them but this will now silently fail to generate a bug report. Perhaps that\u0027s the intended consequence when there\u0027s no description, just wanted to point it out. Also, I believe the descriptions will need to fit on the remainder of a single line in the commit message (though it\u0027s possible we might be able to accommodate some RFC 822 type indented continuation for header parsing if absolutely necessary).","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"56193519d879620b06f348550d6798cea882a71b","unresolved":false,"context_lines":[{"line_number":49,"context_line":"  that no one uses it. This would mean that rather than typing \"DocImpact\" and"},{"line_number":50,"context_line":"  moving on with their lives, contributors must write \"DocImpact: Something"},{"line_number":51,"context_line":"  relevant here\". This isn\u0027t foolproof, but it would hopefully encourage"},{"line_number":52,"context_line":"  contributors to think through what they\u0027re actually asking for."},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* Currently, the five defcore projects (Nova, Swift, Keystone, Glance, and"},{"line_number":55,"context_line":"  Cinder) have the DocImpact flag raising bugs automatically into the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_7ca7ffbc","line":52,"in_reply_to":"ba15a1d1_0beb3b79","updated":"2015-09-17 21:44:39.000000000","message":"Yes, I agree that the education campaign is key. I am hoping that core teams would start picking it up if someone used DocImpact without a description, so the community would self-police on it fairly well once everyone realised how it works.\n\nI\u0027m leaving that up to you Infra guys to decide whether or not that\u0027s possible :P","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"914e61baa6d86fdce02bee83c70a8f4db493f0e5","unresolved":false,"context_lines":[{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* Currently, the five defcore projects (Nova, Swift, Keystone, Glance, and"},{"line_number":55,"context_line":"  Cinder) have the DocImpact flag raising bugs automatically into the"},{"line_number":56,"context_line":"  openstack- manuals queue. All other projects raise a bug in their own bug"},{"line_number":57,"context_line":"  queue instead. Consider changing this behaviour so that the defcore projects"},{"line_number":58,"context_line":"  also raise bugs in their own queues, and their bug triagers are responsible"},{"line_number":59,"context_line":"  for kicking them over the fence to openstack-manauls rather than the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"5a2ca52d_1a1e8b63","line":56,"updated":"2015-10-14 19:41:08.000000000","message":"By default docimpact creates bugs in openstack-manuals unless  specified differently. So, that\u0027s different than you describe. There are many projects that are setup using the default.\n\nAn alternative of this point is as fungi wrote on IRC \"one possible extension to that spec is to invert the docimpact-group parameter so that only projects whose docs bugs are desired by the docs team go to the central tracker and the rest get handled by those projects\u0027 bug trackers (similar to how the groups parameter works)\". \n\nAlone this change would help us reduce a bit of noise.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"bb762ca411276df45d35e10cff29a8fdde4e2f08","unresolved":false,"context_lines":[{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* Currently, the five defcore projects (Nova, Swift, Keystone, Glance, and"},{"line_number":55,"context_line":"  Cinder) have the DocImpact flag raising bugs automatically into the"},{"line_number":56,"context_line":"  openstack- manuals queue. All other projects raise a bug in their own bug"},{"line_number":57,"context_line":"  queue instead. Consider changing this behaviour so that the defcore projects"},{"line_number":58,"context_line":"  also raise bugs in their own queues, and their bug triagers are responsible"},{"line_number":59,"context_line":"  for kicking them over the fence to openstack-manauls rather than the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"5a2ca52d_8d16d053","line":56,"in_reply_to":"5a2ca52d_1a1e8b63","updated":"2015-11-06 03:42:47.000000000","message":"Yes, I agree, this would definitely help. I think it\u0027s a good thing to do in addition.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"0e155c82a50dfdcf85fddf7afa25030a6614da66","unresolved":false,"context_lines":[{"line_number":57,"context_line":"  queue instead. Consider changing this behaviour so that the defcore projects"},{"line_number":58,"context_line":"  also raise bugs in their own queues, and their bug triagers are responsible"},{"line_number":59,"context_line":"  for kicking them over the fence to openstack-manauls rather than the"},{"line_number":60,"context_line":"  reverse. This might only be suitable for some projects, not all of them."},{"line_number":61,"context_line":""},{"line_number":62,"context_line":"* Create an education campaign on the dev mailing list, and possibly other"},{"line_number":63,"context_line":"  channels, in order to try and encourage contributors to use the flag"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_ab048f49","line":60,"updated":"2015-09-17 11:42:31.000000000","message":"This is basic configuration adjusted by adding, removing or changing a docimpact-group option for each relevant project in the gerrit/projects.yaml file of the openstack-infra/project-config repo.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"56193519d879620b06f348550d6798cea882a71b","unresolved":false,"context_lines":[{"line_number":57,"context_line":"  queue instead. Consider changing this behaviour so that the defcore projects"},{"line_number":58,"context_line":"  also raise bugs in their own queues, and their bug triagers are responsible"},{"line_number":59,"context_line":"  for kicking them over the fence to openstack-manauls rather than the"},{"line_number":60,"context_line":"  reverse. This might only be suitable for some projects, not all of them."},{"line_number":61,"context_line":""},{"line_number":62,"context_line":"* Create an education campaign on the dev mailing list, and possibly other"},{"line_number":63,"context_line":"  channels, in order to try and encourage contributors to use the flag"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_9c9e9361","line":60,"in_reply_to":"ba15a1d1_ab048f49","updated":"2015-09-17 21:44:39.000000000","message":"Great. Now we just need to determine which projects can/should raise bugs in our queue.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"0e155c82a50dfdcf85fddf7afa25030a6614da66","unresolved":false,"context_lines":[{"line_number":61,"context_line":""},{"line_number":62,"context_line":"* Create an education campaign on the dev mailing list, and possibly other"},{"line_number":63,"context_line":"  channels, in order to try and encourage contributors to use the flag"},{"line_number":64,"context_line":"  responsibly."},{"line_number":65,"context_line":""},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_cb01c339","line":64,"updated":"2015-09-17 11:42:31.000000000","message":"And to remind them that it will stop working at all without adding a description.","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"56193519d879620b06f348550d6798cea882a71b","unresolved":false,"context_lines":[{"line_number":61,"context_line":""},{"line_number":62,"context_line":"* Create an education campaign on the dev mailing list, and possibly other"},{"line_number":63,"context_line":"  channels, in order to try and encourage contributors to use the flag"},{"line_number":64,"context_line":"  responsibly."},{"line_number":65,"context_line":""},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ba15a1d1_bc99177b","line":64,"in_reply_to":"ba15a1d1_cb01c339","updated":"2015-09-17 21:44:39.000000000","message":"+1","commit_id":"118ec92a7ead5af3b31932557d26d402ec2a48cf"},{"author":{"_account_id":7069,"name":"Joshua Hesketh","email":"josh@nitrotech.org","username":"jhesketh"},"change_message_id":"5e1e319b3456b14302f6d35b292f4ae5f95a618e","unresolved":false,"context_lines":[{"line_number":81,"context_line":"  contains docs. This style of commit message then aligns with APIImpact,"},{"line_number":82,"context_line":"  where the API Working Group reviews incoming patches with that tag. This"},{"line_number":83,"context_line":"  won\u0027t work currently, as we don\u0027t have a good mechanism for searching for"},{"line_number":84,"context_line":"  the flag (the current docs dashboard doesn\u0027t do this)."},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"* Do nothing. Leave the ``DocImpact`` flag the way it is, and slowly drown."},{"line_number":87,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"da85f559_fda81c22","line":84,"updated":"2015-11-11 10:41:47.000000000","message":"Hopefully this changes soon with newer gerrits, but that\u0027s probably still some times off (I don\u0027t believe it\u0027s in next weeks upgrade).\n\nThis could, however, be solved in code. Something that finds all the proposed changes with a DocImpact and lists them somewhere.","commit_id":"b1ac261553cf21fb6a347ab13b74a7c50b599ecc"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"868e2aed9024d668395694898935392bead78f05","unresolved":false,"context_lines":[{"line_number":81,"context_line":"  contains docs. This style of commit message then aligns with APIImpact,"},{"line_number":82,"context_line":"  where the API Working Group reviews incoming patches with that tag. This"},{"line_number":83,"context_line":"  won\u0027t work currently, as we don\u0027t have a good mechanism for searching for"},{"line_number":84,"context_line":"  the flag (the current docs dashboard doesn\u0027t do this)."},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"* Do nothing. Leave the ``DocImpact`` flag the way it is, and slowly drown."},{"line_number":87,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"da85f559_82406308","line":84,"in_reply_to":"da85f559_fda81c22","updated":"2015-11-12 00:38:58.000000000","message":"Yeah, that\u0027s a nice to have, but probably not feasible as a solution at this point.","commit_id":"b1ac261553cf21fb6a347ab13b74a7c50b599ecc"},{"author":{"_account_id":7069,"name":"Joshua Hesketh","email":"josh@nitrotech.org","username":"jhesketh"},"change_message_id":"5e1e319b3456b14302f6d35b292f4ae5f95a618e","unresolved":false,"context_lines":[{"line_number":98,"context_line":"Other contributors:"},{"line_number":99,"context_line":""},{"line_number":100,"context_line":"* Documentation team"},{"line_number":101,"context_line":"* Infra team"},{"line_number":102,"context_line":""},{"line_number":103,"context_line":"Work Items"},{"line_number":104,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":5,"id":"da85f559_7d6bccf1","line":101,"updated":"2015-11-11 10:41:47.000000000","message":"I feel like this should be individual people so that it\u0027s owned or we\u0027ll lose it somewhere in the noise.","commit_id":"b1ac261553cf21fb6a347ab13b74a7c50b599ecc"},{"author":{"_account_id":9162,"name":"Lana Brindley","email":"openstack@lanabrindley.com","username":"loquacity"},"change_message_id":"868e2aed9024d668395694898935392bead78f05","unresolved":false,"context_lines":[{"line_number":98,"context_line":"Other contributors:"},{"line_number":99,"context_line":""},{"line_number":100,"context_line":"* Documentation team"},{"line_number":101,"context_line":"* Infra team"},{"line_number":102,"context_line":""},{"line_number":103,"context_line":"Work Items"},{"line_number":104,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":5,"id":"da85f559_825703c9","line":101,"in_reply_to":"da85f559_7d6bccf1","updated":"2015-11-12 00:38:58.000000000","message":"Agreed. Are you able to find Infra people willing to take this on? I\u0027m happy to own it from the docs side.","commit_id":"b1ac261553cf21fb6a347ab13b74a7c50b599ecc"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"1fe3ca5a83a416a4b728528fecdc16c5743d1af6","unresolved":false,"context_lines":[{"line_number":106,"context_line":"* Enforce a description field on the DocImpact flag"},{"line_number":107,"context_line":""},{"line_number":108,"context_line":"* Review the projects that can raise DocImpact flags in the openstack-manuals"},{"line_number":109,"context_line":"  queue."},{"line_number":110,"context_line":""},{"line_number":111,"context_line":"* Plan and implement an education campaign."},{"line_number":112,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"da85f559_d675c463","line":109,"updated":"2015-11-12 07:17:48.000000000","message":"I can take care of the above, please add me.","commit_id":"b1ac261553cf21fb6a347ab13b74a7c50b599ecc"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"0eec44729168186ee4d5e2af6d4eec416a4ef646","unresolved":false,"context_lines":[{"line_number":56,"context_line":"* Currently, all projects default to create a bug in the openstack-manauals"},{"line_number":57,"context_line":"  queue. This behaviour will be changed so that all projects default"},{"line_number":58,"context_line":"  to raising a bug in their own repo, and only the five defcore projects"},{"line_number":59,"context_line":"  go to the openstack-manuals queue."},{"line_number":60,"context_line":""},{"line_number":61,"context_line":"* Create an education campaign on the dev mailing list, and possibly other"},{"line_number":62,"context_line":"  channels, in order to try and encourage contributors to use the flag"}],"source_content_type":"text/x-rst","patch_set":6,"id":"da85f559_ac8f3acb","line":59,"updated":"2015-11-13 14:23:49.000000000","message":"There are five now, and neutron should probably be added as well as it is on the cusp in a 2016.1 proposal to be added. I suggest you name them here to be clear: nova, swift, glance, keystone, cinder, and neutron.","commit_id":"34bcd5da1428351e4799e327555e937809574145"},{"author":{"_account_id":7069,"name":"Joshua Hesketh","email":"josh@nitrotech.org","username":"jhesketh"},"change_message_id":"245ef1b649622907e7f8b71f0976456918daa5f8","unresolved":false,"context_lines":[{"line_number":51,"context_line":"  relevant here\"."},{"line_number":52,"context_line":""},{"line_number":53,"context_line":"* A Jenkins job is used to test for the description field in patches. If no"},{"line_number":54,"context_line":"  description field is found, the Jenkins job will fail."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"* Currently, all projects default to create a bug in the openstack-manauals"},{"line_number":57,"context_line":"  queue. This behaviour will be changed so that all projects default"}],"source_content_type":"text/x-rst","patch_set":7,"id":"da85f559_f97874fa","line":54,"updated":"2015-11-16 00:32:55.000000000","message":"I think we should still flesh out what the description field should look like. How do we get enough information onto one line, or how do we format multiple lines. What if it needs a really long description - perhaps a commit message isn\u0027t the best place for this etc.","commit_id":"89f7240feb22de0ad02a9c9ff688d31da248c381"}]}