GoogleContainerTools/skaffold

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

Ouverte

#6 840 ouverte le 11 nov. 2021

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Go (1 416 forks)batch import
area/docsarea/onboardingbugbash/q4-2022help wantedkind/documentationkind/todo

Métriques du dépôt

Stars
 (12 822 étoiles)
Métriques de merge PR
 (Merge moyen 3j 6h) (16 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la structure de documentation existante pour le démarrage rapide et les tutoriels afin de déterminer où ajouter des exemples de fichiers skaffold.yaml et quelles configurations courantes démontrer.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80