GoogleContainerTools/skaffold

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

Aberta

#6.840 aberto em 11 de nov. de 2021

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Go (1.416 forks)batch import
area/docsarea/onboardingbugbash/q4-2022help wantedkind/documentationkind/todo

Métricas do repositório

Stars
 (12.822 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 6h) (16 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Examine a estrutura da documentação existente para quickstart e tutoriais para determinar onde adicionar arquivos skaffold.yaml de exemplo e quais configurações comuns demonstrar.
Pilha de tecnologia
go
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80