awslabs / soci-snapshotter

A containerd snapshotter plugin which enables standard OCI images to be lazily loaded without requiring a build-time conversion step.
Apache License 2.0
512 stars 54 forks source link

[DOC] Improve SOCI documentation #405

Open djdongjin opened 1 year ago

djdongjin commented 1 year ago

Is your feature request related to a problem? Please describe.

The GETTING_START doc is too cumbersome (install dep, build/install soci, set up local registry, etc) and need some update.

We should provide individual docs instead of putting all in a GETTING_START, such as:

Describe the solution you'd like

Better documentation, especially GETTING_STARTED and REGISTRY_SUPPORT (with support status on popular registries like dockerhub/ECR/ACR/GCR/GHCR).

Describe alternatives you've considered

No. We need better documentation.

Additional context

I think this is fairly high priority. soci is a open source project. If users cannot try soci easily following a straightforward doc, they probably won't come back.

djdongjin commented 1 year ago

@Kern-- I updated this one with a list of doc/subtasks and my estimation for individual docs (just for reference). This one is ready for estimation.

Kern-- commented 1 year ago

@djdongjin to take BUILD/INSTALL @turan18 to take DEBUG @Kern-- to take REGISTRY

sparr commented 1 year ago

709 asks for consistent verbiage to refer to soci binaries, etc, being implemented in #730

sparr commented 1 year ago

736 asks for documenting the authorization process