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

add a new blog post for ORAS v0.15 #61

Merged
merged 10 commits into from
Oct 25, 2022
Merged

add a new blog post for ORAS v0.15 #61

merged 10 commits into from
Oct 25, 2022

Conversation

FeynmanZhou
Copy link
Member

No description provided.

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>
@FeynmanZhou
Copy link
Member Author

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.

Copy link
Contributor

@SteveLasker SteveLasker left a 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.

docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
## Fetch and view the manifest of a sample Docker image

```
$ oras manifest fetch docker.io/library/hello-world@sha256:f54a58bc1aac5ea1a25d796ae155dc228b3f0e11d046ae276b39c4bf2f13d8c4
Copy link
Contributor

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?

Copy link
Member Author

@FeynmanZhou FeynmanZhou Oct 19, 2022

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.

Copy link
Contributor

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.

Copy link
Member Author

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.

docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
@sajayantony
Copy link
Contributor

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.

docs/blog/index.md Outdated Show resolved Hide resolved
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
Copy link
Contributor

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.

docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
docs/blog/oras-0.15-a-fully-functional-registry-client.md Outdated Show resolved Hide resolved
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou requested review from qweeah, sajayantony and SteveLasker and removed request for qweeah, sajayantony and SteveLasker October 25, 2022 16:54
@FeynmanZhou FeynmanZhou requested review from sajayantony and removed request for sajayantony October 25, 2022 16:54
@FeynmanZhou
Copy link
Member Author

Updated according to the comments above

@lachie83
Copy link
Contributor

/lgtm

@sajayantony sajayantony merged commit aa01805 into oras-project:main Oct 25, 2022
@SteveLasker
Copy link
Contributor

Kudos to publishing:
@FeynmanZhou, the ordering in the TOC is a bit confusing for which is the newest. Suggest a quick fix to put the latest at the top.

This section has some redundant words as well:

In ORAS CLI 0.16 and ORAS-go v2.0.0-rc.4, we'll add support for the OCI artifact spec will be the most significant plan and is targeted to be released at the end of October.

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.

6 participants