GoogleContainerTools/skaffold

Improve distinction between builder and build-environments

Open

#6,659 opened on Oct 1, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/docsbugbash/q4-2022help wantedkind/documentationkind/friction

Description

Expected behavior

Actual behavior

WORST DOCUMENTATION EVER, AND NO WAY TO TELL WHAT IS WHAT AND WHERE ... HORRIFIC EXPERIENCE, WRITTEN BY FOLKS WHO HAVE NO IDEA HOW TO WRITE ANY DOCO WHATSOEVER

To use the 'docker' builder, remove the 'cluster' stanza from the 'build' section of your configuration.

But your doco shows they go hand in hand, and yes the api version matches .

COMPLETE WASTE OF TIME

Information

  • Skaffold version:
  • Operating system:
  • Installed via:
  • Contents of skaffold.yaml:
<paste your skaffold.yaml here>

Steps to reproduce the behavior

  1. a clonable repository with the sample skaffold project
  2. skaffold <command>
  3. ...

Contributor guide

Tech stack
godockerkubernetes
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
basic knowledge of Skaffoldunderstanding of Docker and Kubernetes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review the Skaffold documentation sections on builders and build environments, specifically how the 'docker' builder and 'cluster' stanza are described. Look for contradictions or lack of clarity. The issue mentions that the current docs suggest they go hand in hand but also that removing the cluster stanza is needed. Investigate the official Skaffold docs and example configurations to propose clearer language or restructuring.
Improve distinction between builder and build-environments · GoogleContainerTools/skaffold#6659 | Good First Issue