Skip to content

Move plugin-architecture Piped usage guide to official documentation #6742

@charantejguniganti

Description

@charantejguniganti

*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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions