Docs move keyless info to overview #156

jonvnadelberg · 2023-04-25T22:15:47Z

Fixes #155

Summary

Removes duplicate information and clarifies information in overview.md

Release Note

NONE

Documentation

Doc only fix

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

netlify · 2023-04-25T22:15:55Z

✅ Deploy Preview for docssigstore ready!

Name	Link
🔨 Latest commit	`b70c8a9`
🔍 Latest deploy log	https://app.netlify.com/sites/docssigstore/deploys/6452deb416f93600085f2f0b
😎 Deploy Preview	https://deploy-preview-156--docssigstore.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

jonvnadelberg · 2023-04-25T22:17:08Z

@olivekl Please review.

I didn't change the name of the keyless.md file, but did change it's purpose. Should we create a whole new file with the same content and get rid of keyless.md?

haydentherapper

Overall, I don't think we need to change anything in overview.md. Summarizing my suggestions:

Let's rename keyless.md to "public_deployment.md", and update the title. That gives us a place to add content about the public deployment
Let's create "timestamping.md" and move the section on timestamps to it.
Move "Custom Components" section under "verify.md"
After that, revert all changes done to overview.md

That will result in duplicated content being deleted from "keyless.md", and removing the "ttl.sh" example which I personally don't think is needed.

content/en/cosign/keyless.md

content/en/cosign/overview.md

dmitris · 2023-04-26T15:37:51Z

I wonder where the "non-Fulcio keyless" use case (the one with short-lived keys and provided certificate-chain + identity) would be documented, thinking of sigstore/cosign#2845 and #153?

haydentherapper · 2023-04-26T15:44:37Z

@dmitris - In verify.md, as you proposed. "keyless.md" and "openid_signing.md" are being cleaned up to remove duplication.

jonvnadelberg · 2023-04-26T17:29:23Z

@Hayden Blauzvern ***@***.***> to clarify. You want overview.md to remain completely the same as it was, and keyless.md to be as edited, but renamed? What about the ttl.sh info that is now in overview.md? Don't we want that information someplace? Or do you feel that people should know how to use ttl.sh and crane enough such that they can figure this out for themselves? I think we should have some sort of quickstart container build for people to test with.

…

On Wed, Apr 26, 2023 at 8:44 AM Hayden B ***@***.***> wrote: @dmitris <https://github.com/dmitris> - In verify.md, as you proposed. "keyless.md" and "openid_signing.md" are being cleaned up to remove duplication. — Reply to this email directly, view it on GitHub <#156 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A5CUIOL2ZDNUEKNBFTKZXPLXDE7HDANCNFSM6AAAAAAXLTI5ZQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

haydentherapper · 2023-04-26T17:58:23Z

I would love for someone else to chime in too, but my thought is that ttl.sh is just for testing and not something someone should do for real-world usage. crane is already discussed in the signing docs too. I was thinking either we'd remove ttl.sh entirely, or we have a dedicated subsection in the quickstart guide showing its uagae, but make it clear this is just an example.

dmitris · 2023-04-27T09:17:32Z

I was thinking either we'd remove ttl.sh entirely
I learned about ttl.sh from the examples currently in https://docs.sigstore.dev/cosign/keyless/#quickstart and it seems great for ad-hoc testing, it would be too bad if that pointer disappear completely

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

add note saying that for the example we are using script variable. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

add context to revert section Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

haydentherapper · 2023-05-02T15:16:57Z

Looks great!

cpanato · 2023-05-02T23:31:23Z

content/en/cosign/public_deployment.md

+1. `rm -r ~/.sigstore`
+1. `curl -O https://raw.githubusercontent.com/sigstore/root-signing/main/staging/repository/1.root.json`
+1. `cosign initialize --mirror=https://tuf-repo-cdn.sigstore.dev --root=1.root.json`
+1. `COSIGN_EXPERIMENTAL=1 cosign sign --oidc-issuer "https://oauth2.sigstage.dev/auth" --fulcio-url "https://fulcio.sigstage.dev" --rekor-url "https://rekor.sigstage.dev" ${IMAGE_DIGEST}`


we can drop the experimental and need to add the --yes flag as well in the sign

Agreed on dropping experimental. I'd not include "--yes" though, because we don't want the examples to be skipping through that prompt

makes sense

content/en/cosign/public_deployment.md

jonvnadelberg · 2023-05-03T18:51:53Z

A few comments / suggestions / questions here. Thanks!

changes implemented

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

add id info to verify, remove "experimental" Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

remove typo. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

change OIDC issuer to accounts.example.com Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

typo Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

add https to oidc issuer example. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

haydentherapper · 2023-05-03T22:34:33Z

@ltagliaferri Can you take another look?

haydentherapper · 2023-05-08T19:09:17Z

Bumping for review

jonvnadelberg added 19 commits April 25, 2023 10:15

Update overview.md

d3d9f95

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update keyless.md

63d773f

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

c3e0d71

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

adb4898

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update keyless.md

692e90e

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

17f26b6

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

b95a8cd

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

39413a8

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update keyless.md

d1b5b6c

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

6f9cac5

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update keyless.md

a5a075a

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

65c1572

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

14d9ac9

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

ab06411

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

7526fdb

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

825e974

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

03f344f

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

b9c04a9

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update keyless.md

7640526

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

jonvnadelberg requested review from ltagliaferri and haydentherapper April 25, 2023 22:16

haydentherapper requested changes Apr 26, 2023

View reviewed changes

haydentherapper mentioned this pull request Apr 26, 2023

Fix docs for keyless verification #159

Closed

jonvnadelberg and others added 11 commits May 1, 2023 06:13

Update content/en/cosign/overview.md

be54ac5

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/overview.md

bf6d409

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/public_deployment.md

934e1dd

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/public_deployment.md

fca18d1

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/overview.md

b3057e1

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/timestamps.md

3c38e82

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update content/en/cosign/verify.md

5e871a2

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update overview.md

23d1341

add note saying that for the example we are using script variable. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Merge branch 'sigstore:main' into docs_move_keyless_info_to_overview

bbe7314

Update content/en/cosign/public_deployment.md

bbd724d

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com> Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update public_deployment.md

730fcdb

add context to revert section Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

jonvnadelberg requested review from ltagliaferri and haydentherapper May 1, 2023 19:55

haydentherapper previously approved these changes May 2, 2023

View reviewed changes

cpanato reviewed May 2, 2023

View reviewed changes

content/en/cosign/public_deployment.md Outdated Show resolved Hide resolved

Update public_deployment.md

1d55d4a

Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

jonvnadelberg dismissed haydentherapper’s stale review via 1d55d4a May 3, 2023 22:06

jonvnadelberg added 5 commits May 3, 2023 15:09

Update public_deployment.md

e564f57

add id info to verify, remove "experimental" Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update public_deployment.md

aebdcce

remove typo. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update public_deployment.md

bc0d384

change OIDC issuer to accounts.example.com Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update public_deployment.md

aae8c53

typo Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

Update public_deployment.md

b70c8a9

add https to oidc issuer example. Signed-off-by: jonvnadelberg <121979961+jonvnadelberg@users.noreply.github.com>

ltagliaferri approved these changes May 9, 2023

View reviewed changes

ltagliaferri merged commit b8fc14d into sigstore:main May 9, 2023

jonvnadelberg deleted the docs_move_keyless_info_to_overview branch June 8, 2023 14:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs move keyless info to overview #156

Docs move keyless info to overview #156

jonvnadelberg commented Apr 25, 2023 •

edited

Loading

netlify bot commented Apr 25, 2023 •

edited

Loading

jonvnadelberg commented Apr 25, 2023

haydentherapper left a comment

dmitris commented Apr 26, 2023 •

edited

Loading

haydentherapper commented Apr 26, 2023

jonvnadelberg commented Apr 26, 2023 via email

haydentherapper commented Apr 26, 2023

dmitris commented Apr 27, 2023

haydentherapper commented May 2, 2023

cpanato May 2, 2023

haydentherapper May 2, 2023

cpanato May 2, 2023

jonvnadelberg commented May 3, 2023

haydentherapper commented May 3, 2023

haydentherapper commented May 8, 2023

Docs move keyless info to overview #156

Docs move keyless info to overview #156

Conversation

jonvnadelberg commented Apr 25, 2023 • edited Loading

Summary

Release Note

Documentation

netlify bot commented Apr 25, 2023 • edited Loading

✅ Deploy Preview for docssigstore ready!

jonvnadelberg commented Apr 25, 2023

haydentherapper left a comment

Choose a reason for hiding this comment

dmitris commented Apr 26, 2023 • edited Loading

haydentherapper commented Apr 26, 2023

jonvnadelberg commented Apr 26, 2023 via email

haydentherapper commented Apr 26, 2023

dmitris commented Apr 27, 2023

haydentherapper commented May 2, 2023

cpanato May 2, 2023

Choose a reason for hiding this comment

haydentherapper May 2, 2023

Choose a reason for hiding this comment

cpanato May 2, 2023

Choose a reason for hiding this comment

jonvnadelberg commented May 3, 2023

haydentherapper commented May 3, 2023

haydentherapper commented May 8, 2023

jonvnadelberg commented Apr 25, 2023 •

edited

Loading

netlify bot commented Apr 25, 2023 •

edited

Loading

dmitris commented Apr 26, 2023 •

edited

Loading