hashicorp/waypoint-examples

Add extra documentation to help users get started with Kubernetes examples

Open

#68 opened on Jun 2, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)PHP (84 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (320 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

We have a handful of kubernetes examples but they don't explain the environment needed to set it up and try it out.

Describe the example scenario you wish to be included

Write a quick README in the kubernetes folder that gives some examples on how to set up a k8s environment and what might be needed to use the example. Mostly just link to existing docs and guides to help users get started.

Contributor guide

Research direction
Create a README in the kubernetes folder that explains how to set up a Kubernetes environment and how to use the existing example files. Link to official Kubernetes docs and relevant guides.
Tech stack
None
Domain
infrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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