slsa icon indicating copy to clipboard operation
slsa copied to clipboard

Published 20 hours ago • verified publisher icon slsa-framework

Restructure URIs to be `/<version>/<page>` (no `/spec`)?

Open MarkLodato opened this issue 1 year ago • 4 comments

Now that we are versioning all the specifications together (#680), I propose:

  1. We change our URL scheme to be: /v1.0/<page> instead of a combination of /spec/v1.0/<page>, /provenance/v1, and /verification_summary/v1. This will make it easier to link between pages and view everything as a unit.

  2. We keep the predicateType the same and just redirect /provenance/v1 to /v1.0/provenance (and similar for VSA). That is, the predicateType URI only contains a major version number, while the URL in the browser includes the minor version number and has a slightly different format to decrease the chance of confusing the two.

Any thoughts?

MarkLodato avatar Mar 24 '23 16:03 MarkLodato

I'm going to remove this from v1.0. We can always do this later and set up redirects.

MarkLodato avatar Mar 27 '23 17:03 MarkLodato

This would also solve the problem of next/previous links not crossing the spec/provenance/verification_summary boundary, as mentioned by @olivekl in https://github.com/slsa-framework/slsa/pull/832#issuecomment-1505971000.

MarkLodato avatar Apr 13 '23 12:04 MarkLodato

This would also solve the problem of next/previous links not crossing the spec/provenance/verification_summary boundary, as mentioned by @olivekl in #832 (comment).

I think that's right.

lehors avatar Apr 13 '23 12:04 lehors

I like this suggestion.

joshuagl avatar Apr 13 '23 12:04 joshuagl