GoogleContainerTools/skaffold

Better documentation for running skaffold in docker

Open

#4,033 opened on Apr 27, 2020

View on GitHub
 (9 comments) (2 reactions) (0 assignees)Go (1,416 forks)batch import
area/docshelp wantedkind/documentationpriority/p3

Repository metrics

Stars
 (12,822 stars)
PR merge metrics
 (Avg merge 1d 18h) (18 merged PRs in 30d)

Description

we should put together a small quickstart and best practice guide for running skaffold through the provided docker image. we could give quick examples for running locally in the docker daemon, running on a cluster building with kaniko (locally or remote), and running in a cloud build pipeline.

Contributor guide

Research direction
Review the issue comments (9 existing) for specific user pain points. Examine the existing docs/ directory for structure. Create a new file e.g., docs/docker quickstart.md covering the scenarios mentioned. Ensure examples are tested with the latest skaffold version.
Tech stack
godocker
Domain
devopscloud
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic Docker knowledgeFamiliarity with skaffold
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70