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

Replace tuf roles overview image with text table #73

Merged
merged 4 commits into from
Nov 22, 2019

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Nov 21, 2019

Fixes #66

Copy link
Member Author

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

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

So far I only extracted the text from the original pep-0458-1.png and put it in a text table without changing the contents. Here are two suggestion that we should fix:

| | resulting delegated roles can then provide their own |
| | metadata files. The format of the metadata files provided |
| | by delegated targets roles is the same as that of |
| | targets.json. As with targets.json, the latest version of |
Copy link
Member Author

Choose a reason for hiding this comment

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

Might be good to state that the targets role writes to "targets.json", at this point the reader does not know that yet (they might have a suspicion though).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Go for it :yolo:

pep-0458.txt Outdated
| | versions of all metadata files on the repository in |
| | snapshot.json. The only metadata file not listed in |
| | snapshot.json is timestamp.json, which is always created |
| | after snapshot.json. |
Copy link
Member Author

Choose a reason for hiding this comment

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

This needs to be updated to the latest version of the spec. The current spec does not have root in snapshot either.

Copy link
Collaborator

@trishankatdatadog trishankatdatadog left a comment

Choose a reason for hiding this comment

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

💯

@trishankatdatadog
Copy link
Collaborator

@lukpueh Go for it, do what you think is best

@lukpueh
Copy link
Member Author

lukpueh commented Nov 21, 2019

@trishankatdatadog, let me know what you think of 5b8e5b1. The targets update is not absolutely necessary. But we do need to mention that root is no longer in snapshot. Feel free to suggest alternative wording.

| | resulting delegated roles can then provide their own |
| | metadata files. The format of the metadata files provided |
| | by delegated targets roles is the same as that of |
| | targets.json. As with targets.json, the latest version of |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Go for it :yolo:

pep-0458.txt Outdated Show resolved Hide resolved
lukpueh and others added 4 commits November 22, 2019 11:11
Requires updating other captions:
- Figure 2 --> Figure 1
- Table 1, 2, 4 --> Table 2, 3, 4

This commit also removes a stray "and".
- Update targets row to say that it signs the targets metadata
- Update snapshot row to mention that it only lists targets and
  targets metadata and why it doesn't list root and timestamp.

Co-Authored-By: Trishank Karthik Kuppusamy <[email protected]>
@lukpueh lukpueh merged commit 8b17d9f into secure-systems-lab:1st-draft Nov 22, 2019
lukpueh added a commit to lukpueh/peps that referenced this pull request Mar 5, 2020
In secure-systems-lab#73 Figure 2 became Figure 1. This change
fixes a missed reference update.

It also removes a stray "and".

Signed-off-by: Lukas Puehringer <[email protected]>
ewdurbin added a commit to python/peps that referenced this pull request Mar 5, 2020
In secure-systems-lab#73 Figure 2 became Figure 1. This change
fixes a missed reference update.

It also removes a stray "and".

Signed-off-by: Lukas Puehringer <[email protected]>
mnm678 pushed a commit to mnm678/peps that referenced this pull request Oct 22, 2020
In secure-systems-lab#73 Figure 2 became Figure 1. This change
fixes a missed reference update.

It also removes a stray "and".

Signed-off-by: Lukas Puehringer <[email protected]>
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.

Turn Figure 1 into a text table
2 participants