GoogleContainerTools/skaffold

docs: No example skaffold.yaml files users can copy/paste to get started

Open

#6,840 opened on Nov 11, 2021

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

Description

The skaffold.dev website is currently lacking any simple skaffold.yaml files that users can copy paste.

  • The quickstart points (without a hyperlink) to the examples repo by telling users to clone it.
  • Tutorials require users to "Run in Cloud Shell" etc. (except two of them with more advanced titles do have skaffold.yaml embedded in them).

I think we ought to show users a basic skaffold.yaml as part of the Getting Started experience.

Contributor guide

Tech stack
go
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of KubernetesFamiliarity with skaffold concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue requests adding example skaffold.yaml files to the official documentation, specifically the quickstart guide. The current website lacks copy paste examples, pointing users to clone the examples repo instead. Look at the skaffold.dev website's docs/quickstart/ page and the examples repository (GoogleContainerTools/skaffold/tree/master/examples) to understand the current structure. The task involves creating minimal, copy paste ready skaffold.yaml files and embedding them directly in the documentation. No linked PRs or comments specify exact locations, so selecting appropriate examples from the existing repo is recommended.
docs: No example skaffold.yaml files users can copy/paste to get started · GoogleContainerTools/skaffold#6840 | Good First Issue