-
Notifications
You must be signed in to change notification settings - Fork 62
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
add a new blog post for ORAS v0.15 #61
Conversation
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Hi @SteveLasker @lachie83 @yizha1 @sajayantony @dtzar @oras-project/oras-maintainers Could you pls help to review this blog post? The preview link is available here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, looks great. A few nits on digest vs. tag, and consistency on the commands $
, some links, and tweak on who submitted the OCI spec changes.
The only other thing I'd suggest is upleveling the oras blob commands in the doc as it went deep without context, and I'd suggest we could do a better experience for the manifest conversation scenario.
If you're just trying to upload/download blobs, that makes sense to round out the primitives in the cli, I just don't think the experience reads that well as blog content.
Keep up the great work, particularly as we get to kubecon.
## Fetch and view the manifest of a sample Docker image | ||
|
||
``` | ||
$ oras manifest fetch docker.io/library/hello-world@sha256:f54a58bc1aac5ea1a25d796ae155dc228b3f0e11d046ae276b39c4bf2f13d8c4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove $
to be consistent with other commands, enabling users to copy/paste
Could we change the fetch to a tag? Is there a reason we wanted to be overly cryptic with a digest? Nice that digest is supported, but is it the primary scenario?
BTW, does oras support tag to digest discovery?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove $ to be consistent with other commands, enabling users to copy/paste
If there is an output in the command line, $
is supposed to be added at the beginning. If not, we don't need to add $
.
This symbol is used to help readers distinguish between the input command and output.
Could we change the fetch to a tag? Is there a reason we wanted to be overly cryptic with a digest? Nice that digest is supported, but is it the primary scenario?
Yes. The reason we use digest here is that we want to specify the OS/ARCH of Linux/amd64
for this Docker image. Both digest and tag are supported, it depends on the user's requirement.
BTW, does oras support tag to digest discovery?
Do you mean oras tag [flags] <name>{:<tag>} <new_tag@<digest>>
? Can you clarify this question? Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I understand the delineation you're trying to make with $
, but it's really confusing to see. Some commands I can just copy/paste, others will have the $
which I can't paste. I'd suggest KISSing it (Keep It Silly Simple)
For the hello-word digest, can you just use the platform architecture tag(hello-world:linux): https://hub.docker.com/_/hello-world/tags
Saying you support digests as well is great. This is another example of keeping it crisp and simple, showing a tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The platform architecture tag(hello-world:linux) is not worked with oras manifest fetch
after testing it.
Recommend using the alias everywhere since we want the blog post to showcase the ease of use. The long commands are present in the official documentation and I hopefully we will be moving to the short commands as the actual command in 0.16 anyway. |
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
## Fetch and view the manifest of a sample Docker image | ||
|
||
``` | ||
$ oras manifest fetch docker.io/library/hello-world@sha256:f54a58bc1aac5ea1a25d796ae155dc228b3f0e11d046ae276b39c4bf2f13d8c4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I understand the delineation you're trying to make with $
, but it's really confusing to see. Some commands I can just copy/paste, others will have the $
which I can't paste. I'd suggest KISSing it (Keep It Silly Simple)
For the hello-word digest, can you just use the platform architecture tag(hello-world:linux): https://hub.docker.com/_/hello-world/tags
Saying you support digests as well is great. This is another example of keeping it crisp and simple, showing a tag.
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Updated according to the comments above |
/lgtm |
Kudos to publishing: This section has some redundant words as well:
|
No description provided.