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 quickstart tutorial #816

Open
Tracked by #778
Wwwsylvia opened this issue Aug 29, 2024 · 3 comments
Open
Tracked by #778

Add a quickstart tutorial #816

Wwwsylvia opened this issue Aug 29, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Wwwsylvia
Copy link
Member

Wwwsylvia commented Aug 29, 2024

We should add a quickstart tutorial similar to the Gin tutorial (rendered page) on the ORAS website, including:

  • How to import oras-go v2.
  • How to write basic code using oras-go v2 APIs.
  • How to run the code.
@Wwwsylvia Wwwsylvia added the documentation Improvements or additions to documentation label Aug 29, 2024
@FeynmanZhou
Copy link
Member

Should we transfer this issue to ORAS-WWW repo?

@Wwwsylvia
Copy link
Member Author

We still need a one in oras-go repo for tracking. I think we can create the same issue in ORAS-WWW instead of transferring this one.

@Wwwsylvia Wwwsylvia added this to the v2.6.0 milestone Sep 3, 2024
@FeynmanZhou
Copy link
Member

It might be friendly to document how to authenticate with an OCI registry in oras-go either as new lib users asked about this question in Slack. @Wwwsylvia

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants