Incorrect JSON/XML examples

[Jamie Hannaford]

I've created a script which trawls docs.openstack.org for erroneous or malformed JSON/XML examples. There are currently 31 errors in the markup.

The log file describing each error is attached.

[Andreas Jaeger (jaegerandi)]

I expect that most of these have been addressed since I've seen many patches flying by. Jamie, could you rerun your script, please?

Note that some of the issues the script finds will be to obsolete files that are not part of the manuals anymore.

[Jamie Hannaford (jamie-hannaford)]

I'm still seeing 28 errors. Some of them might be on deprecated pages (which need to be deleted), or fail to validate because of their call-out annotations. For the latter, I can add in some kind of ignore check if I know a common markup pattern (e.g. a <span> tag).

I've attached the full log.

[Andreas Jaeger (jaegerandi)]

Jamie, I think all are fixed besides the Havana ones which we won't fix anymore.

Could you rerun again, please?

[Jamie Hannaford (jamie-hannaford)]

There are 20 errors remaining, but all of these are either related to:

1. Havana release - which we can safely ignore

2. Annotated code samples - which contain nested markup

Is it essential to embed markup in code samples? If so, I'll close this bug.

Full list here: http://23.253.217.46/log/docs.openstack.org.log

[Andreas Jaeger (jaegerandi)]

ERROR 1+19 are IMHO a false positive
ERRORs 2-5,20 Indeed like above.

ERROR 6+7+13+14: These files is are orphaned, not published anymore.

15+16+17+18: those have been fixed today by Roger's commit

Diane, what to do about the annotated code samples?

[Andreas Jaeger (jaegerandi)]

15-18 is an orphaned file, current one:

http://docs.openstack.org/trunk/config-reference/content/section_compute-scheduler.html#scheduler-filters

[Diane Fleming (diane-fleming)]

Annotated code samples are okay.

[Diane Fleming (diane-fleming)]

https://review.openstack.org/172764

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/172765

[Diane Fleming (diane-fleming)]

https://review.openstack.org/172765

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/172765
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=04cf11aeaa565699d6217158dbc3823f22000be0
Submitter: Jenkins
Branch: master

commit 04cf11aeaa565699d6217158dbc3823f22000be0
Author: Diane Fleming <email address hidden>
Date: Sun Apr 12 18:40:50 2015 -0500

    Fix code samples

    Change-Id: I8aa109b9bb673bf6454b06af4e78da0cc1af74d9
    Closes-Bug: #1285604