pipe-cd / pipe-cd/pipecd

Move plugin-architecture Piped usage guide to official documentation

Open
#6,742 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhancement
Dominant language
Go
Stars
1.4k
Forks
364
Avg merge
1d 4h
Merged PRs (30d)
84

Description

*What would you like to be added:

Move the plugin-architecture Piped usage guide from:

cmd/pipedv1/README-usage-alpha.md

to the official documentation under:

docs/content/en/docs-v1.0.x/installation/install-piped/plugin-architecture.md

This would include:

  • Migrating all relevant sections (Prerequisites, Setup Control Plane, Run Piped, Deploy an Application)
  • Replacing the "alpha" notice with a proper Hugo alert block
  • Updating internal links to align with documentation pages
  • Converting the existing README into a pointer to the new documentation

Why is this needed:

  • Improves discoverability, as users typically look for installation guidance in the official docs/ directory rather than inside cmd/
  • Provides a more structured and complete documentation experience
  • Reduces maintenance overhead by leveraging Hugo-based docs (versioning, search, consistent styling)
  • Improves onboarding for new users and contributors by centralizing important usage instructions

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 by reading cmd/pipedv1/README-usage-alpha.md and the surrounding pages under docs/content/en/docs-v1.0.x/installation/install-piped/. Move the Prerequisites, Setup Control Plane, Run Piped, and Deploy an Application sections into plugin-architecture.md, update internal links and the alpha notice, then convert the README into a pointer to the new page. Done means the content is discoverable in the official documentation with consistent Hugo formatting and working links.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.