[Openstack-docs] openstack-manuals and gate changes

Anne Gentle annegentle at justwriteclick.com
Tue Aug 20 16:01:11 UTC 2013


On Fri, Aug 16, 2013 at 2:40 PM, Andreas Jaeger <aj at suse.com> wrote:

> On 08/16/2013 09:07 PM, Anne Gentle wrote:
> > Hi all,
> > You may have noticed there has been a lot of discussion in reviews
> > around the validation gate for openstack-manuals. Or perhaps you didn't
> > notice, and that's why I'm talking about this on the list. I also need
> > to straighten it out in my own mind. Writing helps. :)
> >
> > I like the idea of categories of gating jobs. Some are voting, which
> > means your patch will get a red X mark. Some are non-voting, which means
> > your patch will get an informative message telling you some of your
> > submission isn't right.
> >
> > So I want to sort out what we want to test on new submissions:
> >
> > This is the most important one: Do all the books build? If not which
> > ones are problematic and why? Ideally the gate test will build only the
> > books that have changed files. Is this happening now?
>
> AFAIK all books build - and the gate test only builds those books that
> have changed files. Still, this needed a couple of iterations to get
> right, so everybody should double check that there are no further bugs
> in it.
>
>
This is looking good and caught a missing xi:include for me while working
on moving content into the Configuration Reference. Greatly appreciated!


> > This is less important to me: Are we being careful about whitespace? If
> > not which ones are failing the whitespace tests?
> >
> > And this one is problematic: Do individual files validate? With xrefs in
> > the source file, the files will not validate in Oxygen. To me,
> > validation can be non-voting as long as the books build.
>
>
> > We can use 1.9.0 (or 1.9.2 when it's released) in the pom.xml but also
> > the xlink markup would have to be changed. This isn't an
> > overnight-flip-the-switch kind of change. We need to talk about
> > policies. Let's have that discussion at the boot camp.
>
> Please write this up for those that won't be there.
>

Yep, will do. We're documentors! :)


>
> > Also, we need the "Failed" messages about images to be fixed in the
> > build tool in order to make these logs more useful. David, definitely
> > move this bug up on your priority
> > list. https://bugs.launchpad.net/openstack-manuals/+bug/1193491
>
> Indeed, it produces lots of noise.
>
> > In the meantime, let's make sure whitespace remains non-voting.
>
> There's a patch from Tom that needs approval:
> https://review.openstack.org/#/c/41623/
>
> Also, I suggest to get this one in - to produce less whitespace:
> https://review.openstack.org/#/c/41627/
>
>
Both are in now and we're only gating on "does it build?"

Thanks for the good work!
Anne


>  > Any questions? I don't know if I clarified much but I wanted to ensure
> > you know I'm paying attention and doing what I can to mitigate any
> > difficulties getting good content through the gate.
>
> I think we're on a good way forward.
>
> Thanks,
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: 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
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130820/9b2e1572/attachment.html>


More information about the Openstack-docs mailing list