[Openstack-docs] Checking JSON/XML errors on docs.openstack.org

Jamie Hannaford jamie.hannaford at rackspace.com
Wed Feb 26 14:04:49 UTC 2014


Hey,

Andreas Jaeger recently updated openstack-doc-tools to support JSON validation checks:

http://lists.openstack.org/pipermail/openstack-docs/2014-February/003885.html

Following this, I've also written a script that checks every single piece of documentation on 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 sub-domain that need to be corrected. The full report is attached.

The scraper can be found here with usage instructions:

https://github.com/jamiehannaford/doc-validator

It's particularly useful because you can aim it at any base URI and have the entire domain trawled for a set pattern in the markup.

Jamie



Jamie Hannaford
Software Developer II - CH      [experience Fanatical Support]

Tel:    +41434303908
Mob:    +41791009767
        [Rackspace]



Rackspace International GmbH a company registered in the Canton of Zurich, Switzerland (company identification number CH-020.4.047.077-1) whose registered office is at Pfingstweidstrasse 60, 8005 Zurich, Switzerland. Rackspace International GmbH privacy policy can be viewed at www.rackspace.co.uk/legal/swiss-privacy-policy
-
Rackspace Hosting Australia PTY LTD a company registered in the state of Victoria, Australia (company registered number ACN 153 275 524) whose registered office is at Suite 3, Level 7, 210 George Street, Sydney, NSW 2000, Australia. Rackspace Hosting Australia PTY LTD privacy policy can be viewed at www.rackspace.com.au/company/legal-privacy-statement.php
-
Rackspace US, Inc, 5000 Walzem Road, San Antonio, Texas 78218, United States of America
Rackspace US, Inc privacy policy can be viewed at www.rackspace.com/information/legal/privacystatement
-
Rackspace Limited is a company registered in England & Wales (company registered number 03897010) whose registered office is at 5 Millington Road, Hyde Park Hayes, Middlesex UB3 4AZ.
Rackspace Limited privacy policy can be viewed at www.rackspace.co.uk/legal/privacy-policy
-
Rackspace Benelux B.V. is a company registered in the Netherlands (company KvK nummer 34276327) whose registered office is at Teleportboulevard 110, 1043 EJ Amsterdam.
Rackspace Benelux B.V privacy policy can be viewed at www.rackspace.nl/juridisch/privacy-policy
-
Rackspace Asia Limited is a company registered in Hong Kong (Company no: 1211294) whose registered office is at 9/F, Cambridge House, Taikoo Place, 979 King's Road, Quarry Bay, Hong Kong.
Rackspace Asia Limited privacy policy can be viewed at www.rackspace.com.hk/company/legal-privacy-statement.php
-
This e-mail message (including any attachments or embedded documents) is intended for the exclusive and confidential use of the individual or entity to which this message is addressed, and unless otherwise expressly indicated, is confidential and privileged information of Rackspace. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse at rackspace.com and delete the original message. Your cooperation is appreciated.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0001.html>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: docs.openstack.org.log.txt
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0001.txt>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image581fbd.JPG
Type: image/jpeg
Size: 3124 bytes
Desc: image581fbd.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0004.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image560a20.JPG
Type: image/jpeg
Size: 990 bytes
Desc: image560a20.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0005.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image6c6909.JPG
Type: image/jpeg
Size: 6844 bytes
Desc: image6c6909.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0006.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: imageec9756.JPG
Type: image/jpeg
Size: 1074 bytes
Desc: imageec9756.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140226/dc34d240/attachment-0007.jpe>


More information about the Openstack-docs mailing list