Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[jakarta.ee-spec.committee] TCK URL inconsistencies
The URL of the TCK needs to appear in 4 places for a specification review:
  1. The text of the Pull Request
  2. In the _index.md file in the Pull Request
  3. In the Compatibility Certification Request issue
  4. In the TCK Results Summary (because it needs to include a copy of the Compatibility Certification Request)
The first one needs to be the URL of the staged TCK, so that we can review it.

The last three need to be the URL that the TCK will appear at once the spec is approved, so that these web pages will be valid after approval.
No one seems to understand that the last three need to be the same, need to be different than the first one, and will not be valid at the time they're entered.

Ed did an audit of these URLs; see the attached spreadsheet.  The entries in green are correct.  You'll see that almost all of the #2 - #4 entries are wrong.  We're going to correct the ones that we can, and ask others to correct the ones we can't.

Given the widespread confusion over this, it raises the issue...

Maybe we're doing the wrong thing?

Maybe we're asking people to do something that's so difficult or counterintuitive that they're never going to get it right?

I'm looking for ideas of how to improve the situation.

Obviously the easiest thing for us to do is to improve the instructions.  I'm highly doubtful that that will be sufficiently effective.

We could invest in a "spec lint" tool that would automate the detection and reporting of these errors, allowing submitters to correct them before we see them.  I believe David started something like this.  I also threw together a script to check these TCK URLs (after Ed did the audit by hand, of course).  I think this will be useful for other issues, but some of these checks will be very ad hoc and will require updating with each release.

We could stop asking for the TCK URL in the _index.md file, and fill that in for them when we publish the file.  (We should also fill in links to the SHA-256 and the digital signature.)

We could stop requiring the Compatibility Certification Request and the TCK Results summary to have duplicate information and put it in one place and link to the other.  (Although I understand the rationale for having it in both places.)

Anyone have any other ideas?

Attachment: Jakarta-TCK-Tracking 2.xlsx
Description: MS-Excel 2007 spreadsheet

Back to the top