Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nonspec: Create dedicated current activities page #1268

Merged
merged 11 commits into from
Jan 14, 2025

Conversation

marcelamelara
Copy link
Contributor

Following our ongoing discussions about questions of SLSA's current status, I quickly put together a new page for the website that outlines our current activities. This is mostly meant to be a starting point that we can improve upon as we figure out the best way to communicate our ongoing activities.

Copy link

netlify bot commented Jan 6, 2025

Deploy Preview for slsa ready!

Name Link
🔨 Latest commit c49e863
🔍 Latest deploy log https://app.netlify.com/sites/slsa/deploys/677ebcecda33090008756248
😎 Deploy Preview https://deploy-preview-1268--slsa.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@marcelamelara marcelamelara changed the title Create dedicated current activities page nonspec: Create dedicated current activities page Jan 6, 2025
@marcelamelara
Copy link
Contributor Author

Actually, something is still off about how the new page is being formatted. If anyone has any ideas for what I'm missing, please let me know.

@TomHennen
Copy link
Contributor

Actually, something is still off about how the new page is being formatted. If anyone has any ideas for what I'm missing, please let me know.

Just guessing..., the other examples I see (e.g. https://github.com/slsa-framework/slsa/blob/main/docs/spec/draft/whats-new.md?plain=1) don't specify layout: standard. What happens if you remove that?

docs/_data/nav/draft.yml Outdated Show resolved Hide resolved
docs/current-activities.md Outdated Show resolved Hide resolved
docs/current-activities.md Outdated Show resolved Hide resolved
docs/current-activities.md Outdated Show resolved Hide resolved
docs/spec/draft/future-directions.md Show resolved Hide resolved
@marcelamelara
Copy link
Contributor Author

Just guessing..., the other examples I see (e.g. https://github.com/slsa-framework/slsa/blob/main/docs/spec/draft/whats-new.md?plain=1) don't specify layout: standard. What happens if you remove that?

I'll give this a try. FWIW, I copied the top matter from the community page, which does seem to use "standard" layout.

Copy link
Member

@lehors lehors left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for doing this.
I noticed that on the front page (index.md) we have a section titled 'Project status' but it is all the way at the bottom of a really long page. I think it would be worth updating that section to add a link to this new page and move that section much higher up onto the page. But this could be done in a different PR focused on refreshing the home page which could use a bit of scrubbing (like the list of companies listed is seriously out of date).

@marcelamelara
Copy link
Contributor Author

I noticed that on the front page (index.md) we have a section titled 'Project status' but it is all the way at the bottom of a really long page. I think it would be worth updating that section to add a link to this new page and move that section much higher up onto the page.

So this means we have the same text copied in two different places, because the exact same "Project status" section was (before I edited it) on the Community page. I vote to only keep one version of 'Project Status' so we don't have to remember to sync these two pages. Having this blurb on index.md makes more sense to me.

But this could be done in a different PR focused on refreshing the home page which could use a bit of scrubbing (like the list of companies listed is seriously out of date).

In general, I think we'll need several PRs to update several pages. The Community page is also seriously out of date, for example. What I can do in this PR is move the updated 'Project Status' out of the Community page into index.md, and a future PR can handle restructuring/other updates of the landing page.

@marcelamelara
Copy link
Contributor Author

CC @michaelwinser

marcelamelara and others added 8 commits January 7, 2025 07:55
Co-authored-by: Tom Hennen <[email protected]>
Signed-off-by: Marcela Melara <[email protected]>
Signed-off-by: Marcela Melara <[email protected]>
Signed-off-by: Marcela Melara <[email protected]>
@lehors
Copy link
Member

lehors commented Jan 8, 2025

I noticed that on the front page (index.md) we have a section titled 'Project status' but it is all the way at the bottom of a really long page. I think it would be worth updating that section to add a link to this new page and move that section much higher up onto the page.

So this means we have the same text copied in two different places, because the exact same "Project status" section was (before I edited it) on the Community page. I vote to only keep one version of 'Project Status' so we don't have to remember to sync these two pages. Having this blurb on index.md makes more sense to me.

Yes, I fully agree. We should avoid duplication at all cost.

But this could be done in a different PR focused on refreshing the home page which could use a bit of scrubbing (like the list of companies listed is seriously out of date).

In general, I think we'll need several PRs to update several pages. The Community page is also seriously out of date, for example. What I can do in this PR is move the updated 'Project Status' out of the Community page into index.md, and a future PR can handle restructuring/other updates of the landing page.

Sounds good.

docs/current-activities.md Outdated Show resolved Hide resolved
marcelamelara and others added 2 commits January 8, 2025 08:28
Signed-off-by: Marcela Melara <[email protected]>
Co-authored-by: Arnaud J Le Hors <[email protected]>
Signed-off-by: Marcela Melara <[email protected]>
@marcelamelara marcelamelara requested a review from lehors January 8, 2025 17:59
@marcelamelara marcelamelara added the website Issues with the slsa.dev website label Jan 8, 2025
Copy link
Member

@mlieberman85 mlieberman85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@arewm arewm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments are relatively minor. Additional general comment: should we also link to the specific issues summarizing the refinement of these new tracks?

Comment on lines +24 to +25
The goal of a Build Environment track is to enable the detection of tampering
with core components of the compute environment executing builds.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we introducing terminology here? Should we just say the build platform?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What terms are you concerned about specifically?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given #1275, I'm going to defer any potential changes here to a later PR.

Comment on lines +36 to +37
These requirements are **subject to significant change** while this track
is in draft.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you trying to highlight that the build environment track has had less iteration/refinement than the source track? This feels like it should be a general call-out instead of a specific one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not specifically, the intent here was simply to emphasize that the BuildEnv track is still in draft, irrespective of the status of the source track. I don't mind removing this line if you think it's redundant.

@lehors lehors mentioned this pull request Jan 14, 2025
@marcelamelara marcelamelara merged commit 2a6ff2a into slsa-framework:main Jan 14, 2025
6 checks passed
lehors added a commit that referenced this pull request Jan 23, 2025
Here is my first take on the new navigation approach.

This PR doesn't make any changes to how the specification is organized
with regard to the tracks, etc. It is meant to be merely a UI
modification, essentially changing the navigation bar so that the
various versions of the specification are directly visible and
accessible rather than dependent on using the version selector which
only appears once you go into the specification.

I didn't include the older versions: 0.1 and 1.0-rc1 and rc2. All of
these are however still there and can be accessed directly via their
respective URLs or from any page linking to them such as past blog
posts. Let me know if you think we should add 0.1 to the navigation bar.
I'm also not sure there is value in having the 1.1 RC given that I think
it's a dead-end (if anything I think this should be 1.0.1).

In the process of making this change I found a few bugs that I was able
to fix.

Any feedback or suggestions welcome but please keep in mind that Jekyll
is a **static** page generator so anything that requires dynamic
processing (either server-side or client-side) is out of scope. These
would require PHP and/or Javascript. I've more or less managed to get my
head around Jekyll and its template programming language Liquid but I'm
not up for the added complexity any of this would imply.

PR #1268 will have a small impact that I'll handle once it is merged.

---------

Signed-off-by: Arnaud J Le Hors <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website Issues with the slsa.dev website
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants