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 full documentation for new image tooling #53

Open
cyphar opened this issue Oct 25, 2016 · 0 comments
Open

add full documentation for new image tooling #53

cyphar opened this issue Oct 25, 2016 · 0 comments

Comments

@cyphar
Copy link
Member

cyphar commented Oct 25, 2016

Currently all of our tooling only really has documentation for each piece. However, once #5 and #8 are merged we will (in principle) have all of the tooling necessary to create an OCI image from scratch using nothing but OCI tooling.

However, because of how each tool is split, we need to have documentation on how you can actually combine all of the pieces. While it may seem somewhat obvious once you've played with it for a bit, it would be quite useful for people who want to use the binaries (or even use the libraries) to understand what the flow should look like.

The documentation could just be an example shell session going from an empty directory to an OCI image which then can be unpacked and set up as a runtime bundle.

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

1 participant