pipe-cd / pipe-cd/pipecd

[doc] Add examples of piped config for each platform

Open
#4,816 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs kind/enhancement not-auto-close
Dominant language
Go
Stars
1.4k
Forks
364
Avg merge
1d 4h
Merged PRs (30d)
84

Description

What would you like to be added:

We need examples of piped config files, which are related to https://pipecd.dev/docs/user-guide/managing-piped/adding-a-platform-provider/.
Especially, there are two ways for Kubernetes: to the same cluster and to an external cluster.

Why is this needed:

To inform users clearly how to configure piped.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the adding-a-platform-provider guide linked in the issue and review how piped configuration is currently documented. Add clear configuration examples for each platform, including Kubernetes connections to the same cluster and to an external cluster. Done means users can find and understand the relevant piped configuration for every supported platform.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.