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

Create E2E examples #434

Closed
Wwwsylvia opened this issue Feb 8, 2023 · 4 comments · Fixed by #561
Closed

Create E2E examples #434

Wwwsylvia opened this issue Feb 8, 2023 · 4 comments · Fixed by #561
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Wwwsylvia
Copy link
Member

Currently we have several runnable examples for specific APIs. However, we don't have any E2E examples that demonstrates how the APIs can be used together.

@Wwwsylvia Wwwsylvia added the documentation Improvements or additions to documentation label Feb 8, 2023
@shizhMSFT shizhMSFT added this to the v2.1.0 milestone Feb 24, 2023
@shizhMSFT shizhMSFT modified the milestones: v2.1.0, v2.2.0 May 4, 2023
@Wwwsylvia Wwwsylvia modified the milestones: v2.2.0, v2.3.0 May 24, 2023
@sparr
Copy link
Contributor

sparr commented Jun 20, 2023

Adding some narrative descriptions of example examples here would make it easier for a contributor to implement examples.

@wangxiaoxuan273
Copy link
Contributor

I'd like to work on this.

@Wwwsylvia
Copy link
Member Author

Wwwsylvia commented Jun 27, 2023

Adding some narrative descriptions of example examples here would make it easier for a contributor to implement examples.

We can migrate the existing quick start examples to the go reference:

  1. Push files to a remote repository
  2. Pull files from a remote repository
  3. Pull a docker or OCI image from a remote repository to a local OCI layout
  4. Pull an image using the docker credentials store

And we can also have some examples like:

  • Copy an image from an OCI layout tar archive to a remote repository

Please feel free to share any additional examples that you think would be helpful for users.

@Wwwsylvia
Copy link
Member Author

Wwwsylvia commented Jul 24, 2023

We can also add the links to the new examples in the README: https://github.com/oras-project/oras-go#v2-stable

Wwwsylvia pushed a commit that referenced this issue Aug 4, 2023
Resolves #434 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
Wwwsylvia pushed a commit that referenced this issue Aug 7, 2023
Following up issue #434 
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
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
Development

Successfully merging a pull request may close this issue.

4 participants