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 (1,416 forks)batch import
area/docsarea/onboardingbugbash/q4-2022help wantedkind/documentationkind/todo

Repository metrics

Stars
 (12,822 stars)
PR merge metrics
 (Avg merge 3d 6h) (16 merged PRs in 30d)

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

Research direction
Look at the existing documentation structure for quickstart and tutorials to determine where to add example skaffold.yaml files and what common configurations to demonstrate.
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.
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.
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