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 an API architecture diagram and Quick Start guide for the ORAS Go library #67

Open
FeynmanZhou opened this issue Nov 15, 2022 · 3 comments

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Nov 15, 2022

We need to create an API architecture diagram for the ORAS library (ORAS-go, ORAS-py) to illustrate the API function and logic, this will help new folks easily understand the ORAS API capabilities.

ORAS-py has made good examples at user guide and developer guide. So this issue is mainly for ORAS-go.

@FeynmanZhou FeynmanZhou changed the title Create an API architecture diagram for the ORAS library Create an API architecture diagram and Quick Start guide for the ORAS Go library Jan 6, 2023
@Wwwsylvia
Copy link
Member

I can take this for oras-go.
I think we can add the below content as the first step:

1. What is oras-go 
	- Short description
2. Get Started 
	- How to import the package
	- Simple End-to-end examples
3. Architecture Diagram
       - Abstractions and APIs

@FeynmanZhou
Copy link
Member Author

@Wwwsylvia This proposal looks good to me. Let's start with this content structure for ORAS-go quick start.

@DishaJain17
Copy link

@FeynmanZhou Kindly have a look
https://docs.google.com/document/d/1eylGDc36ohhki_8UaDLKpoDn7Ih_A9SOMKRh8jbEQxc/edit
Please review the attached detailed flowchart without design for your review. Kindly provide feedback , your input is greatly appreciated.
Thanks

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

No branches or pull requests

3 participants