Good note, also like the subject line suggestion David had. I especially like that it doesn't hint that they're getting to throw it over a wall into a writer group to snag. :) I like your careful wording. Anne
On Friday, October 26, 2012, Tom Fifield wrote: > Example email - what do you think? > > > Devs Please Read: DocImpact - getting information to the docs team > > > > TL;DR - If anything you submit could have an impact on documentation, > just add "DocImpact" to a line in your commit message. > > Developers, > > > We need your help. > > In the face of the 500 contributors to the code base, those small > handful of us working on documentation are losing the war. > > One of the worst pains we have right now is that we're not getting > information from you about the changes you make. We just don't have the > people to review every single commit on every single project for its > impact on documentation. > > This is where you can make a difference. > > If your commit could have an impact on documentation - be it an > added/altered/removed commandline option, a deprecated or new feature, a > caveat, if you've written docs in the patch, or if you're just not sure > - there's a way to let us know. > > => Just add "DocImpact" to a line in your commit message. > > This sends us an email so we can triage. It doesn't guarantee docs will > be written, but at least it gives us visibility of the changes. > > > Thanks for reading :) > > As always - if you have any time to write/fix docs, we've more than one > hundred bugs waiting for your contribution . . . > > > Regards, > > > Tom > > On 26/10/12 13:10, Ying Chun Guo wrote: > > Agree. > > I didn't hear about this tag before. > > We should make this tag well-known by all developers. > > > > Regards > > Daisy > > > > openstack-doc-core-bounces+guoyingc=cn.ibm....@lists.launchpad.net<javascript:;>wrote > > on 2012/10/26 09:19:23: > > > >> Russell Bryant <[email protected] <javascript:;>> > >> Sent by: > > openstack-doc-core-bounces+guoyingc=cn.ibm....@lists.launchpad.net<javascript:;> > >> > >> 2012/10/26 09:19 > >> > >> To > >> > >> [email protected] <javascript:;>, > >> > >> cc > >> > >> Subject > >> > >> Re: [Openstack-doc-core] We need to talk about DocImpact > >> > >> On 10/25/2012 06:20 PM, Anne Gentle wrote: > >> > So, Joe Heck just sent a message to all the PTLs and Cced me, saying > he > >> > needed a clue stick and encouraging other PTLs to use the flag. :) So > >> > you could certainly send a reminder to all devs with instructions as > Joe > >> > wasn't even sure how it all worked. > >> > >> I would definitely recommend posting to the openstack-dev list. > >> Everyone writing patches needs to know about it, not just the PTLs. > >> > >> -- > >> Russell Bryant > >> > >> -- > >> Mailing list: https://launchpad.net/~openstack-doc-core > >> Post to : [email protected] <javascript:;> > >> Unsubscribe : https://launchpad.net/~openstack-doc-core > >> More help : https://help.launchpad.net/ListHelp > >> > > > > > > > -- > Mailing list: https://launchpad.net/~openstack-doc-core > Post to : [email protected] <javascript:;> > Unsubscribe : https://launchpad.net/~openstack-doc-core > More help : https://help.launchpad.net/ListHelp >
-- Mailing list: https://launchpad.net/~openstack-doc-core Post to : [email protected] Unsubscribe : https://launchpad.net/~openstack-doc-core More help : https://help.launchpad.net/ListHelp
