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

Tiled tree codelab #77

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Tiled tree codelab #77

wants to merge 3 commits into from

Conversation

phbnf
Copy link
Contributor

@phbnf phbnf commented Jan 16, 2024

codelab.md is an extension of README.md, exploring the successive states a tiled tree is in when it grows.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (149d17d) 55.99% compared to head (dafbf17) 55.99%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   55.99%   55.99%           
=======================================
  Files           8        8           
  Lines         759      759           
=======================================
  Hits          425      425           
  Misses        265      265           
  Partials       69       69           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@phbnf phbnf requested a review from mhutchinson April 22, 2024 09:08
@phbnf phbnf marked this pull request as ready for review April 22, 2024 09:09
Copy link
Contributor

@mhutchinson mhutchinson left a comment

Choose a reason for hiding this comment

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

As I'm reading this, I see a lot of overlap between this and the main docs at https://github.com/transparency-dev/serverless-log. What's the intended difference?

I see from the comment above that it's thought of as an extension to the README. Does it make sense to just extend it? The log setup is the same for all of them I think?

Use the `generate_keys` command with `--key_name`, a name
for the signing entity. You can output the public and private keys to files using
`--out_pub` path and filename for the public key,
`--out_priv` path and filename for the private key
Copy link
Contributor

Choose a reason for hiding this comment

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

This is quite the sentence. It looks like you tried to make it bullet points from the md file. Maybe do that so that it reads cleaner in the rendered file?

@phbnf
Copy link
Contributor Author

phbnf commented Apr 22, 2024

I see a lot of overlap between this and the main docs at https://github.com/transparency-dev/serverless-log

Indeed, there's a lot of overlap, this PR was started with cp README.md codelab.md.

What's the intended difference?

The README in its current form explains how to use the various commands in this repo. This codelab explains what happens under the hood when commands are called, and what effects they have on data.

It might be a bit heavy lifted for someone who opens this repo for the first time to dive into these details, so I didn't want to pollute the README. It reflects the journey I went through a few months ago when I looked into this format, so I thought others who are interested in details might benefit from this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants