-
Notifications
You must be signed in to change notification settings - Fork 64
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
Refactor the ORAS documentation structure and write new user guides #65
Comments
I am interested in working on this issue and contributing to ORAS documentation. I have few doubts and ideas in mind, but I am unable to join the slack workspace. I have commented about the same problem in #158 (comment) |
I find Meshery's Docs (docs.meshery.io) to be quite detailed and developer friendly. I feel ORAS Docs can be structured in a similar fashion with more in depth knowledge of features mentioned in the issue. The docs can be made interactive by incorporating mock up of ORAS CLI in them (if possible to do so). |
I am interested in this. |
You can join the Slack channel, with the provided link on the website. If that doesn't work, you can join the CNCF Slack and then navigate to the |
Hey, Mentors @TerryHowe , @asmitbm , @FeynmanZhou. My name is Roseline and I'm interested in contributing to this project. |
Hey Mentors @asmitbm @TerryHowe @FeynmanZhou . My name is Shashank Kumar and I am interested in contributing to this project. |
@asmitbm I am unable to join the Slack channel. |
Hi @yash7raut, You can use this link: https://communityinviter.com/apps/cloud-native/cncf |
Thank you for the link @asmitbm. What should be my next steps? I am exploring the repository and trying to familiarize myself with the project. |
Hey Mentors @asmitbm @TerryHowe @FeynmanZhou . My name is Vikash Kumar Yadav and I am very myuch interested in contributing to this project. Can u please suggest me any first contributor issue? |
Hey, can anyone tell me the deadline for applying to this mentorship? |
Deadline to apply is May 23rd 5PM PDT. |
Done. |
This issue relates to a proposal for a LFX mentorship project for Term 2, 2023. Please feel free to comment on this issue about your interest and willingness, but note that commenting here is not the same as applying to LFX.
The detailed ORAS documentation structure and content should be refactored and updated to the latest version of ORAS. I would like to propose the new documentation structure as follows.
- Use cases
- Demos
- Roadmap
- Pull and push artifacts
- Attach files to artifacts
- Copy artifacts across registries
- Discover referrers of a manifest
- Repository and tag operations
- Manifest and blob operations
- Using ORAS in CI/CD (e.g. GitHub Actions)
- Working with OCI Registries
- Using ORAS with Kubernetes manifest
- How to build ORAS CLI
- Add a new command and flag
- CLI release process
- Golang library guide
- API reference
- Python library guide
The text was updated successfully, but these errors were encountered: