Open Stack

I've created this bug issue with an attached list:

https://bugs.launchpad.net/openstack-api-site/+bug/1285604

Call-outs seem to be specified by using <span> tags in the markup. JavaScript is then used to hide these <span> tags from the DOM when the user double-clicks on the JSON/XML extract. The problem, however, is that wget does not handle JavaScript - so when it scrapes the page, it still sees these red herring HTML <span> tags which causes the parsing check to fail.

Going forward:

- Is there any way to annotate, or at least comment on, a piece of JSON or XML without modifying the structure of the code sample itself? I know Diane added the <callout> nodes.

- If not, do we use a consistent identifier (i.e. a HTML id or CSS class) that I can use to ignore these annotation tags?

Jamie

From: Andreas Jaeger <aj at suse.com<mailto:aj at suse.com>>
Organization: SUSE Linux Products GmbH, Nuernberg, GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer, HRB 16746 (AG Nuernberg)
Date: Wednesday, February 26, 2014 at 8:48 PM
To: Diane Fleming <diane.fleming at RACKSPACE.COM<mailto:diane.fleming at RACKSPACE.COM>>, Anne Gentle <anne at openstack.org<mailto:anne at openstack.org>>
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 02/26/2014 08:35 PM, Diane Fleming wrote:
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


Looks great, see

http://docs-draft.openstack.org/81/76581/1/check/gate-openstack-manuals-tox-doc-publish-checkbuild/f6ed74b/publish-docs/admin-guide-cloud/content/ch_networking.html#section_networking_auth

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




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

Tel:    +41434303908
Mob:    +41791009767
        [Rackspace]




_______________________________________________
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

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/20140227/7fe7ebf2/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image59d661.JPG
Type: image/jpeg
Size: 3124 bytes
Desc: image59d661.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140227/7fe7ebf2/attachment-0004.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image65a83e.JPG
Type: image/jpeg
Size: 990 bytes
Desc: image65a83e.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140227/7fe7ebf2/attachment-0005.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: imageafc917.JPG
Type: image/jpeg
Size: 6844 bytes
Desc: imageafc917.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140227/7fe7ebf2/attachment-0006.jpe>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: imagea3e717.JPG
Type: image/jpeg
Size: 1074 bytes
Desc: imagea3e717.JPG
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140227/7fe7ebf2/attachment-0007.jpe>