Release snapshot format improvements #484

danbri opened this Issue May 13, 2015 · 7 comments


None yet

5 participants

danbri commented May 13, 2015

Following #441 we have a simple "all in one page" snapshot view of each version.

This provides most definitions from versions at stable URLs. Initially:

  • /version/2.0/

At this time the schema encoded in RDFa/RDFS is the canonical representation, and the HTML report is generated programmatically. This meta-issue tracks improvements to the generated HTML release summary page. We may regenerate the snapshot summary from the underlying schema data as this tooling improves, e.g. to provide better formatting and cross-referencing.

Known issues:

  • enums are not represented in human-facing form
  • page navigation is horrible
  • page is gigantic and heavy - should we strip out the definitions, or split them into 1 main line + additional supporting text which might not need to be in the snapshot?
  • other machine formats? JSON-LD, Turtle (TimBL was asking for), N-Quads.
  • should back-port to previous releases.
  • administrivia: document the release process in Wiki.
  • use git tags.
  • /version/x.y/ should link to /docs/releases.html#vx.y
@danbri danbri self-assigned this May 13, 2015
@danbri danbri added this to the 2015 sometime milestone May 13, 2015

Dan, I get 404 on


Take a look at it here - its not released yet.


On 13 May 2015, at 15:12, sopekmir <> wrote:

Dan, I get 404 on

Reply to this email directly or view it on GitHub

danbri commented May 13, 2015

Yes, the point is a launch is imminent but there are some various things that need more attention/time. So this bug is linked from those version snapshot pages.

@danbri danbri added a commit that referenced this issue May 13, 2015
@danbri danbri Working on #484 5e66610
danbri commented May 13, 2015
mfhepp commented May 13, 2015


martin hepp

On 13.05.2015, at 23:17, Dan Brickley wrote:

Ok, we're live.

Reply to this email directly or view it on GitHub.

unor commented May 14, 2015

The "advice" link on is broken:
danbri commented May 14, 2015

Doh, thanks @unor. I've silently fixed this in the live site. I didn't change the archived snapshot in data/releases/2.0/all-schema.html as 1. it isn't served anywhere 2. I think we've set expectations those HTML snapshots will be improved later, only the raw triples are frozen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment