GoogleContainerTools/skaffold

[Docs] Move all inline `skaffold.yaml` snippets to `docs/content/en/samples`

Aberta

#6.589 aberto em 10 de set. de 2021

Ver no GitHubGuia do colaborador
 (4 comentários) (0 reação) (1 responsável)Go (1.416 forks)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

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

Currently there exist skaffold config snippets strewn inline with rest of the docs. These can get stale very quickly. The correct place for these snippets is in docs/content/en/samples directory which has schema validations run as part of unit tests; and referenced in markdown using:

{{% readfile file="samples/path-to-file" %}}

This is a tracking issue to scan the docs and relocate these snippets.

Guia do colaborador

Direção de pesquisa
Examine o diretório docs/content/en em busca de trechos inline de skaffold.yaml, mova cada um para docs/content/en/samples com nomenclatura adequada e substitua o trecho inline por um shortcode {{% readfile file="samples/path to file" %}}. Verifique os exemplos existentes para convenções de nomenclatura.
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
GitMarkdownYAML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80