openstack team mailing list archive

[Tom Fifield <fifieldt@xxxxxxxxxxxxxx>]

With Havana development starting, we're already seeing some DocImpacts 
coming in - thanks for those!

We want to sure we catch all those removals, deprecations and pent-up 
updates that tend to come in at the beginning of the cycle.

So, as usual:

"""
 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.
"""


Don't forget to tell your friends :)


Regards,


Tom, on behalf of the docs team


On 03/01/13 13:25, Tom Fifield wrote:
> Hi all,
>
> Just wanted to drop a quick note on the list to say thanks to all who
> have gone to the effort of using the DocImpact flag in your commit messages.
>
> We're now receiving a steady stream of useful information on changes
> that affect the documentation, and logging and targeting them[1][2]. The
> aim is that as Grizzly is released, the manuals should be much more up
> to date than in previous releases.
>
> Of course, the workload[3] is still a struggle, so any help[4] fixing up
> docbugs is much appreciated :)
>
> Thanks again for your efforts!
>
> Regards,
>
>
> Tom, on behalf of the docs team
>
> [1] https://bugs.launchpad.net/openstack-manuals/+milestone/grizzly
> [2] https://bugs.launchpad.net/openstack-api-site/+milestone/grizzly
> [3] http://kiks.webnumbr.com/untouched-bugs-in-openstack-manuals-
> [4] http://wiki.openstack.org/Documentation/HowTo
>
> On 30/10/12 12:31, Tom Fifield wrote:
> > 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 behalf of the docs team.
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp