apple / apple/swift-container-plugin

`swift-container-plugin`'s use of local registry instances is unclear

Open
#137 0 comments 0 reactions 0 assignees View on GitHub
area/documentation
Dominant language
Swift
Stars
390
Forks
26
Avg merge
8m
Merged PRs (30d)
1

Description

#134 points out that there is no documentation on how to set up a local registry. In addition, the reason the documentation and demos use a local registry is not explained.

`containertool` is currently only able to push an image to a registry - it cannot push to the local container runtime's image store. If pushing to a public registry or private network registry is not suitable, a local instance of [`registry:2`](https://hub.docker.com/_/registry) can be used instead. The documentation should make this clear.

Gaining the ability to push directly to a local engine's image store (#68), or save to disk, would provide alternatives to using a local registry.

Contributor guide

Open the contributing guide

Research direction

Review the documentation and demos referenced by the issue, then read #134 for the missing local-registry context. Explain that containertool currently pushes only to registries, document how to set up a local registry:2 instance, and state why the examples use one. Done when the setup and rationale are clear and the alternatives are identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, swift
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.