Open Stack

Thank you so much, Steve, for the research! It's great to know what caused
this problem so we can all avoid it in the future.

On Saturday, November 16, 2013, Steve Gordon wrote:

> ----- Original Message -----
> > From: "Steve Gordon" <sgordon at redhat.com <javascript:;>>
> > To: "Gauvain Pocentek" <gauvain.pocentek at objectif-libre.com<javascript:;>
> >
> > Cc: "openstack-docs" <openstack-docs at lists.openstack.org <javascript:;>>
> > Sent: Saturday, November 16, 2013 5:54:12 PM
> > Subject: Re: [Openstack-docs] Broken MySQL chapter
> >
> > ----- Original Message -----
> > > From: "Gauvain Pocentek" <gauvain.pocentek at objectif-libre.com<javascript:;>
> >
> > > To: "Anne Gentle" <annegentle at justwriteclick.com <javascript:;>>
> > > Cc: "openstack-docs" <openstack-docs at lists.openstack.org<javascript:;>
> >
> > > Sent: Saturday, November 16, 2013 12:42:36 AM
> > > Subject: Re: [Openstack-docs] Broken MySQL chapter
> > >
> > > Hey,
> > >
> > > Le 15/11/2013 22:01, Anne Gentle a écrit :
> > > > Any root cause we can avoid?
> > >
> > > If we were dealing with code I'd say "we lack unit tests", but for
> > > documentation it is probably very hard to manage (are there some tools
> > > out there to test documentation?).
> >
> > Doing "proper" CI with full coverage that actually extracts and runs all
> the
> > instructions is difficult, but in this case I think we could pick the
> cause
> > of the issue up in validation. I've proposed an update to test.py here:
> >
> >     https://review.openstack.org/#/c/56790/
> >
> > For the change in question the output would have been:
> >
> > python ./tools/test.py --check-syntax
> > Checking syntax of xml files...
> >  Validating install-guide/ch_basics.xml
> >   install-guide/ch_basics.xml: {
> http://docbook.org/ns/docbook}itemizedlist os
> >   profiling (['opensuse', 'sles']) conflicts with os profiling of
> >   {http://docbook.org/ns/docbook}screen on line 276.
> > Check failed, validated 1 xml files with 1 failures.
>
> Running this against all books I found a few other instances of this
> problem we need to look at:
>
> Checking syntax of all xml files...
>   install-guide/section_dashboard-install.xml: {
> http://docbook.org/ns/docbook}step os profiling (['opensuse', 'sles',
> 'fedora', 'centos', 'rhel']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}screen on line 177.
>   install-guide/section_glance-install.xml: {
> http://docbook.org/ns/docbook}step os profiling (['rhel', 'centos',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}para on line 60.
>   install-guide/section_nova-compute.xml: {
> http://docbook.org/ns/docbook}step os profiling (['rhel', 'centos',
> 'fedora']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}screen on line 97.
>   install-guide/section_heat-install.xml: {
> http://docbook.org/ns/docbook}procedure os profiling (['rhel', 'centos',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}para on line 39.
>   install-guide/section_nova-controller.xml: {
> http://docbook.org/ns/docbook}step os profiling (['rhel', 'centos',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}para on line 61.
>   install-guide/section_ceilometer-install.xml: {
> http://docbook.org/ns/docbook}step os profiling (['rhel', 'centos',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}para on line 123.
>   install-guide/section_cinder-node.xml: {
> http://docbook.org/ns/docbook}step os profiling (['centos', 'rhel',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}programlisting on line 117.
>   install-guide/section_cinder-controller.xml: {
> http://docbook.org/ns/docbook}step os profiling (['rhel', 'centos',
> 'fedora', 'opensuse', 'sles', 'ubuntu']) conflicts with os profiling of {
> http://docbook.org/ns/docbook}para on line 38.
> Check failed, validated 717 xml files with 8 failures.
>
> For the most part they seem to be cases where the os profile of the parent
> lists every os *except* debian and then one of the children has os="debian".
>
> -Steve
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org <javascript:;>
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>


-- 
Thank you!

Nermina Miller
Tech Writer and Editor
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131116/3fcdbc09/attachment-0001.html>