Open Stack

See this change for an example of how to include callouts for an included file:

https://review.openstack.org/#/c/76581/1/doc/admin-guide-cloud/section_networking_auth.xml


Diane
----------------------------------------------
Diane Fleming
Software Developer II - US
diane.fleming at rackspace.com
Cell  512.323.6799
Office 512.874.1260
Skype drfleming0227
Google-plus diane.fleming at gmail.com

From: Anne Gentle <anne at openstack.org<mailto:anne at openstack.org>>
Date: Wednesday, February 26, 2014 1:08 PM
To: Andreas Jaeger <aj at suse.com<mailto:aj at suse.com>>
Cc: "openstack-docs at lists.openstack.org<mailto:openstack-docs at lists.openstack.org>" <openstack-docs at lists.openstack.org<mailto:openstack-docs at lists.openstack.org>>
Subject: Re: [Openstack-docs] Checking JSON/XML errors on docs.openstack.org




On Wed, Feb 26, 2014 at 12:55 PM, Andreas Jaeger <aj at suse.com<mailto:aj at suse.com>> wrote:
On 02/26/2014 03:04 PM, Jamie Hannaford wrote:
> [...]
> Following this, I've also written a script that checks every single
> piece of documentation on openstack.org<http://openstack.org> for malformed JSON/XML. Whereas
> Andreas checks during the Jenkins build process, my check allows us to
> see any pre-built documentation errors that are currently live.  Doing
> this, I've found 31 errors on the docs.openstack.org<http://docs.openstack.org> sub-domain that
> need to be corrected. The full report is attached.

Great idea! I think you run it before some changes were merged, could
you rerun it and file a bug report with these instructions, please?

I hope somebody will then fix these ;)

Agreed - although one that was identified is policy.json from the Grizzly documents, where we use annotation inline like [1] [2] [3] which then makes the json invalid. So in fixing that, we need to figure out how to annotate the policy.json file -- any ideas?

Thanks for the work here --- what a great idea for higher quality docs.

Anne

thanks,
Andreas
--
 Andreas Jaeger aj@{suse.com<http://suse.com>,opensuse.org<http://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<mailto:Openstack-docs at lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/50c32b06/attachment.html>