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

Enhance documentation for oras-go v2 #778

Open
6 tasks
Wwwsylvia opened this issue Jun 24, 2024 · 4 comments
Open
6 tasks

Enhance documentation for oras-go v2 #778

Wwwsylvia opened this issue Jun 24, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Wwwsylvia
Copy link
Member

Wwwsylvia commented Jun 24, 2024

While we already have documentation covering the general concepts of ORAS on oras.land and detailed API specifications available on pkg.go.dev, users may still encounter challenges when trying to use oras-go v2 in their projects.

To enhance clarity and usability, we should consider the following improvements:

Related issue: oras-project/oras-www#67

Feel free to share additional ideas or suggestions in the comments! Let’s make the documentation more accessible and user-friendly. 💡

@Wwwsylvia Wwwsylvia added the documentation Improvements or additions to documentation label Jun 24, 2024
@Wwwsylvia
Copy link
Member Author

TODO: break down to more granular tasks

@shizhMSFT
Copy link
Contributor

shizhMSFT commented Jul 1, 2024

It would be better if we have tutorials beyond examples like a tour of go.

We don't need a full website and we can start with just a markdown file like the gin tutorial (rendered page).

@FeynmanZhou
Copy link
Member

@Wwwsylvia I received a feedback about having the subject/referrer relationship made clear in the oras-go docs and add example code of how to add a subject using PackManifest would be super helpful.

@Wwwsylvia
Copy link
Member Author

Wwwsylvia commented Aug 22, 2024

Here are some tasks I'm currently considering:

  • Refine README.md to include a brief summary of the library.
  • Add documentation to clarify common concepts in oras-go v2, including:
    • The concept of Target and content store.
    • A summary for each built-in content store.
    • How to choose the appropriate content store.
  • Add documentation about the modeling of OCI artifacts, including:
    • Visualization of the artifact graph model.
    • The relationship between Predecessors and Referrers.
    • The difference between Copy and ExtendedCopy.
  • Add a quickstart tutorial similar to the Gin tutorial (rendered page), including:
    • How to import oras-go v2.
    • How to write basic code using oras-go v2 APIs.
    • How to run the code.
  • Add E2E examples on:
    • How to attach a blob to an existing artifact in a remote repository.
    • How to push an artifact along with its referrers to a remote repository.
  • Review existing examples and fix any issues found

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

3 participants