OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

regrep message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [regrep] Discovered numerous broken links in Regrep CS documents



Team,

I have created an issue to track this at:

http://jira.wx.ll.mit.edu/browse/REGREPTC-187

In an earlier message, I have explained that there is only one unresolvable link with multiple instances (one for each canonical query). The hyperlink is not significant to the spec at all. Having discussed this with Chet here are some key points:
  • Current OASIS policy does not allow OASIS staff to simply remove the hyperlink, so this is not an option. Chet is compiling a list of minor fixes that will be allowed in future and this will be added to that list
  • Current OASIS policy does not allow OASIS staff to provide a server side redirect to redirect the broken link to the correct one, so this is not an option either.
  • Chet has said that it is up to us whether we fix this minor issue now or simply leave it in. Fixing it now would mean doing another CSD03, then PRD02 and another public review (minimum 2 month delay)
  • I feel strongly that this sort of minor issue should not cost the TC and OASIS Staff huge rework effort and a 2 month delay. It is better to fix it if we have to address a more substantial issue or in a future version of the spec
  • I have asked Chet to go ahead and publish the CS01 with this issue un-addressed so we can move forward to Candidate OASIS Standard and then eventually public review prior to OASIS Standard ballot
I am assuming that no one on the TC will object to this plan. If you do object then please share your thoughts. If so, you also have the opportunity until Thursday afternoon to change your vote on the ballot to publish Candidate OASIS Standard 01.

Lastly, I wanted to express our collective appreciation for the good work that Chet has been doing since becoming the OASIS Staff to shepherd our TC.
Despite a demanding workload he has been helping us every step of the way.

On 08/22/2011 03:05 PM, Farrukh Najmi wrote:
4E52A881.5050603@wellfleetsoftware.com" type="cite">
Hi Chet,

We had used the following online link checker before submitting the specs:

http://validator.w3.org/checklink?uri=http%3A%2F%2Fdocs.oasis-open.org%2Fregrep%2Fregrep-core%2Fv4.0%2Fcsd02%2Fregrep-core-rs-v4.0-csd02.html&hide_type=all&depth=&check=Check

ACTION: TC Members please review results from links below to double check that there are no other errors:


Most of the errors in the result of the link checker are false positives due to links that from URLs that were used in examples and were never meant to be anything more than examples. These all start with "http://acme.com".


Looking at the latest results from CSD02 I find only one link that has several instances that is an actual mistake:

Lines: 7489, 7570, 7785, 8019, 8056, 8191, 8326, 8438, 8673, 8752, 8828, 8933, 9007, 9082, 9174, 9506 http://docs.oasis-open.org/regrep/v4.0/canonical/SubmitObjectsRequest_Queries.xml

The actual links for CSPRD01 should be:

http://docs.oasis-open.org/regrep/regrep-core/v4.0/csprd01/xml/minDB/SubmitObjectsRequest_Queries.xml

The problem is that OASIS does not publish a version independent link to this file at:

http://docs.oasis-open.org/regrep/regrep-core/v4.0/xml/minDB/SubmitObjectsRequest_Queries.xml

The resolution for this one error is to simply remove the hyperlink as it is not actually needed and in fact creates issues because OASIS does not publish a version independent link to the file or its parent directory.

Another possible resolution is to create a redirect from http://docs.oasis-open.org/regrep/v4.0/canonical/SubmitObjectsRequest_Queries.xml

to http://docs.oasis-open.org/regrep/regrep-core/v4.0/csprd01/xml/minDB/SubmitObjectsRequest_Queries.xml at the OASIS web site.

Is either of these (removing hyperlinks in a few places or creating a redirect) something we can do without having to submit another CSD/PRD and creating a lot of work for editors as well as OASIS staff?

Please let us know how you think its bets to proceed and we will work with you to get beyond this.

Lastly, I lets discuss what we can change in the Standards Approval process so minor mistakes like this could be caught earlier before going to public review.

Thank you.

On 08/22/2011 01:36 PM, Chet Ensign wrote:
CAAwgnnPcqRJ+BmqZ7pSL6BPYnn=M8_TnrLL2DD2-1kTjyM4dug@mail.gmail.com" type="cite">
Hi Farrukh, hi Kathryn,

In preparing the Committee Specification files for the 3 parts of
Regrep V4.0, we found numerous broken links. 44 were found in Part 2
and there are some in the other files as well.

Some are broken internal links to different sections of the document.

In Part 2 ebRS, there are many links in function documentation that do
not work. See for example, 2.6 Canonical Query:
ClassificationSchemeSelector where the link behind "canonical query
ClassificationSchemeSelector" doesn't work. It points to the URI
http://docs.oasis-open.org/regrep/v4.0/canonical/SubmitObjectsRequest_Queries.xml
however neither the subdirectory /canonical/ nor the XML exists. (You
can find these in the previous CSD and see the problem there.)

Do you have a link checker that you can use to identify broken links?

Do you want to pull this back from promotion to CS and fix these now?

Please let me know how you want to proceed.


-- 
Regards,
Farrukh Najmi

Web: http://www.wellfleetsoftware.com



-- 
Regards,
Farrukh Najmi

Web: http://www.wellfleetsoftware.com



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]