nonspec: remove unused and outdated motivating example #945
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
✅ Deploy Preview for slsa ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
MarkLodato
reviewed
Aug 17, 2023
There was a problem hiding this comment.
+1 to removing.
Is it worth redirecting to https://github.com/slsa-framework/slsa/blob/a25364a3b312f572e4620c812820249853bb40e5/docs/example.md? In general I prefer keeping URLs working forever, but in this case I don't know if anyone cares.
|
I agree with the goal of having URLs continue to work, so I will set up the redirect even though I'm not sure anyone cares. |
joshuagl
added a commit
to joshuagl/slsa
that referenced
this pull request
Aug 18, 2023
There are several places in the generated site where links are broken because they still include the .md file extension. It's unclear why jekyll-relative-links is broken _only_ in these instances, but this surgical change resolves broken links on the site until the wider issue can be addressed. Before this patch: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/blog.html:the valuable feedback we received on the <a href="2023-02-24-sls a-v1-rc.md">first release candidate</a>. This is _site/blog.html: <p>Interested in getting involved? Now’s the chance to <a href="2023-02-24-slsa-v1-rc.md">provide your feedback on the foundational v1 release of the SLSA framework.</a></p> _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. _site/how-to-orgs.html:<a href="/provenance/v1.md">https://slsa.dev/provenance/</a>.</p> _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future ``` - the two blog.html instances are resolved by editing the individual blog posts to remove the .md file extension - the example.html instance will be resolved by slsa-framework#945 - how-to-orgs.html is fixed by removing the .md extension line 20 of how-to-orgs.md - the v1.0-rc2 threats and onepage are fixed by removing the .md extension in lines 40 and 49 of spec/v1.0-rc2/threats.md - the v1.0 threats and onepage are fixed by removing the .md extension in lines 40 and 49 spec/v1.0/threats.md Following these changes: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. ``` which is resolved by the removal of example.md in PR#945 Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
MarkLodato
approved these changes
Aug 18, 2023
joshuagl
added a commit
to joshuagl/slsa
that referenced
this pull request
Aug 21, 2023
There are several places in the generated site where links are broken because they still include the .md file extension. It's unclear why jekyll-relative-links is broken _only_ in these instances, but this surgical change resolves broken links on the site until the wider issue can be addressed. Before this patch: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/blog.html:the valuable feedback we received on the <a href="2023-02-24-sls a-v1-rc.md">first release candidate</a>. This is _site/blog.html: <p>Interested in getting involved? Now’s the chance to <a href="2023-02-24-slsa-v1-rc.md">provide your feedback on the foundational v1 release of the SLSA framework.</a></p> _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. _site/how-to-orgs.html:<a href="/provenance/v1.md">https://slsa.dev/provenance/</a>.</p> _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future ``` - the two blog.html instances are resolved by editing the individual blog posts to remove the .md file extension - the example.html instance will be resolved by slsa-framework#945 - how-to-orgs.html is fixed by removing the .md extension line 20 of how-to-orgs.md - the v1.0-rc2 threats and onepage are fixed by removing the .md extension in lines 40 and 49 of spec/v1.0-rc2/threats.md - the v1.0 threats and onepage are fixed by removing the .md extension in lines 40 and 49 spec/v1.0/threats.md Following these changes: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. ``` which is resolved by the removal of example.md in PR#945 Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
joshuagl
force-pushed
the
joshuagl/rm-example
branch
from
e0e6132
to
ec6966a
Compare
renovate-bot
pushed a commit
to renovate-bot/slsa
that referenced
this pull request
Aug 22, 2023
There are several places in the generated site where links are broken because: * the generated HTML still includes the .md file extension. It's unclear why jekyll-relative-links is broken _only_ in these instances. * the link is to a moved file in the in-toto/attestation git repository * the link was to a file in our projcet which has moved * the link was always bad (i.e. a link to nist.gov with no proto) This surgical change resolves broken links on the site until the wider issues (disable jekyll-relative-links and broken link detection) can be addressed in issue slsa-framework#938. On broken jekyll-relative-links, specifically, before this patch: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/blog.html:the valuable feedback we received on the <a href="2023-02-24-sls a-v1-rc.md">first release candidate</a>. This is _site/blog.html: <p>Interested in getting involved? Now’s the chance to <a href="2023-02-24-slsa-v1-rc.md">provide your feedback on the foundational v1 release of the SLSA framework.</a></p> _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. _site/how-to-orgs.html:<a href="/provenance/v1.md">[https://slsa.dev/provenance/</a>.</p](https://slsa.dev/provenance/%3C/a%3E.%3C/p)> _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0-rc2/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/onepage.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="#future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future _site/spec/v1.0/threats.html:<p>SLSA v1.0 does not address this threat, but it may be addressed in a <a href="future-directions.md">future ``` - the two blog.html instances are resolved by editing the individual blog posts to remove the .md file extension - the example.html instance will be resolved by slsa-framework#945 - how-to-orgs.html is fixed by removing the .md extension line 20 of how-to-orgs.md - the v1.0-rc2 threats and onepage are fixed by removing the .md extension in lines 40 and 49 of spec/v1.0-rc2/threats.md - the v1.0 threats and onepage are fixed by removing the .md extension in lines 40 and 49 spec/v1.0/threats.md Following these changes: ``` % git grep --color --no-index 'href="[^h][^"]*\.md' _site _site/example.html:<p>SLSA 4 <a href="requirements.md">requires</a> two-party source control and hermetic builds. ``` which is resolved by the removal of example.md in PR slsa-framework#945 Signed-off-by: Joshua Lock <joshuagloe@gmail.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.
The motivating example page is not referenced/linked to by any other
content and has fallen out of date with SLSA v1.
Fixes: #943
Signed-off-by: joshua.lock@uk.verizon.com