GoogleContainerTools/skaffold

[docs] Add documentation for the difference between skaffold commands

Open

#8,071 opened on Nov 11, 2022

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

Description

Add documentation for the difference between skaffold commands (for example, which commands are encompassed by skaffold run).

Contributor guide

Tech stack
go
Domain
documentationcli
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.
clear
Prerequisites
Basic understanding of skaffold CLIAbility to navigate skaffold documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the existing skaffold documentation to understand the current command structure, especially the 'skaffold run' command and its included subcommands. Check the issue comments for any clarification from maintainers. Look at the skaffold help output or code in the cmd/ directory to map all commands and their relationships. Write a new documentation page or section explaining the differences.