editorial: move provenance and VSA under spec dir #939
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Redirect /provenance/v1 and /verification_summary/v1 to
/spec/v1.0/provenance and /spec/v1.0/verification_summary, respectively,
and similarly for older versions. (`predicateType` URIs do NOT change.)
Reasons for this change:
- Make it obvious to the reader that all three are versioned together
and that they form one cohesive specification.
- Make it easier to implement versioning via branches/tags. Previously
we would have had to have either three separate sets of branches/tags
or three sets of directories within each branch/tag, and then merge
files within one directory. Now we can have each version directory
correspond to a branch/tag, which is simpler to understand and
maintain.
- To show the minor version in the URL bar, without affecting the
major-version-only `predicateType`.
Related changes:
- Redirect old URLs to the new location to allow them to continue
working.
- Update any existing links that would have been broken by the change,
namely links to `.md` files and links using relative paths.
- Do not update links to redirected URLs, in order to minimize the
size of this PR. Optionally, a future PR could clean this up.
- Move images and schema files too, since (a) links have to be updated
anyway and (b) it aligns with slsa-framework#936.
- Fix the version selector to properly handle v0.2, which only exists
for provenance and verification_summary.
- Also remove the name "Core specification" from the banner since is
now the only specification.
- Add provenance and verification_summary the "onepage" view. This was
not possible before.
Ideally this would have been broken up into smaller changes, but I could
not figure out a way to do so that would have left the site continuing
to work.
Signed-off-by: Mark Lodato <lodato@google.com>
MarkLodato
force-pushed
the
prov-and-vsa-to-spec
branch
from
62ba28a
to
15a4f9c
Compare
✅ Deploy Preview for slsa ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for slsa ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Although this is technically only an "editorial" change, I think it warrants having several reviewers since the URL is quite an important property. |
Previously the links on the nav bar used the old URLs, e.g. /provenance/v1, which did not correctly highlight the current page. Signed-off-by: Mark Lodato <lodato@google.com>
joshuagl
approved these changes
Aug 4, 2023
Signed-off-by: Mark Lodato <lodato@google.com>
lehors
approved these changes
Aug 14, 2023
Signed-off-by: Mark Lodato <lodato@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Redirect /provenance/v1 and /verification_summary/v1 to
/spec/v1.0/provenance and /spec/v1.0/verification_summary, respectively,
and similarly for older versions. (
predicateTypeURIs do NOT change.)Reasons for this change:
and that they form one cohesive specification.
we would have had to have either three separate sets of branches/tags
or three sets of directories within each branch/tag, and then merge
files within one directory. Now we can have each version directory
correspond to a branch/tag, which is simpler to understand and
maintain.
major-version-only
predicateType.Related changes:
working.
namely links to
.mdfiles and links using relative paths.size of this PR. Optionally, a future PR could clean this up.
anyway and (b) it aligns with impl: move images to versioned spec directory #936.
for provenance and verification_summary.
now the only specification.
not possible before.
Ideally this would have been broken up into smaller changes, but I could
not figure out a way to do so that would have left the site continuing
to work.