GoogleContainerTools/skaffold

Better documentation for running skaffold in docker

Open

#4,033 opened on Apr 27, 2020

View on GitHubContributor guide
 (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
 (PR metrics pending)

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
Read existing skaffold Docker documentation, explore examples in the repo for Docker and kaniko, then write a quickstart guide covering local Docker daemon, cluster building with kaniko, and cloud build pipeline, following the project's documentation style.
Tech stack
godockerkubernetes
Domain
documentationdevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80