isce-framework / isce-framework/dolphin
[New Feature]: Include instructions for using pre-built container from GHCR
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 153
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Alternatives considered
Yes - and alternatives don't suffice
Related problems
README instructions point to building from Docker file which can take a while and depend on users local environment somewhat.
Describe the feature request
The repository CI builds a GHCR container and this can be directly pulled to accelerate setup and usage. Happy to make PR to this effect.
- A pointer to creating GHCR token
- Pulling the image via
docker pull ghcr.io/isce-framework/dolphin:latest - Running the image and mounting volumes to perform basic processing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README instructions for building from the Dockerfile. Add guidance for creating a GHCR token, pulling ghcr.io/isce-framework/dolphin:latest, and running the container with mounted volumes for basic processing. The documentation is done when users can follow the pre-built-container setup without relying on a local image build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, github
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100