[openstack-dev] [Fuel] Documentation process

Andreas Jaeger aj at suse.com
Thu Sep 25 06:39:50 UTC 2014


On 09/24/2014 09:55 PM, Sergii Golovatiuk wrote:
> Hi,
> 
> I would like to discuss the documentation process and align it to
> OpenStack flow.
> 
> At the moment we add special tags to bugs in Launchpad which is not
> optimal as everyone can add/remove tags
> cannot participate in documentation process or
> enforce documentation process.
> 
> I suggest to switch to standard workflow that is used by OpenStack community
> All we need is to move the process of tracking documentation from
> launchpad to gerrit
> 
> This process gives more control to individual developers or community
> for tracking the changes and reflect them in documentation.
> 
> Every reviewer checks the commit. If he thinks that this commit requires
> documentation update, he will set -1 with comment message "Docs impact
> required"
> 
> This will force the author of patchset to update commit with "DocImpact"
> commit message
> 
> Our documentation team will get all messages with DocImpact from 'git
> log'. The documentation team will make a documentation where the author
> of patch will play a key role. All other reviewers from original patch
> must give own +1 for documentation update.
> 
> Patches in fuel-docs may have the same Change-ID as original patch. It
> will allow us to match documentation and patches in Gerrit.
> 
> More details about DocImpact flow ban be obtained at
> 
> https://wiki.openstack.org/wiki/Documentation/DocImpact

Currently all bugs filed due to DocImpact land in the openstack-manuals
launchpad bug area unless the repository is setup in the infrastructure
to push them elsewhere.

If you want to move forward with this, please setup first the
infrastructure to properly file the bugs,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the OpenStack-dev mailing list