Move plugin-architecture Piped usage guide to official documentation
メンテナーはふだん 2 日以内に返信
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 68/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- hugo
調査の方向性
まず cmd/pipedv1/README-usage-alpha.md と、docs/content/en/docs-v1.0.x/installation/install-piped/ 以下の関連ページを読みます。Prerequisites、Setup Control Plane、Run Piped、Deploy an Application の各セクションを plugin-architecture.md に移動し、内部リンクと alpha の注意書きを更新してから、README を新しいページへのポインターに変換します。公式ドキュメントでコンテンツを見つけられ、一貫した Hugo 形式になっており、リンクが機能していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
*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 insidecmd/ - 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
- 主要言語
- Go
- スター
- 1.4k
- フォーク
- 391
- 平均マージ
- 4日 1時間
- マージ済み PR（30日）
- 58
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pipe-cd/pipecd のほかの issue
-
Applications at the repository root are not triggered by new commits対応中かも @Daksha1611 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 2 日以内に返信
-
pipedv1 kubernetes plugins ignore trafficRouting.istio.host in K8S_TRAFFIC_ROUTING対応中かも @Dhirenderchoudhary が今日担当しました。 オープン
難易度 2/5 半日 初心者へのやさしさ 74/100
pipe-cd/pipecd#7626 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
pipectl transfer restore application drops backed-up labels対応中かも @bhavishyajain545 が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
pipe-cd/pipecd#7622 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
docker-compose: postgres healthcheck should probe TCP (pg_isready -h localhost)対応中かも @zezo-mohamed22 が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
OneBusAway/watchdog#305 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
self-care self-care:agent-discoverability
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
githubnext/gh-cao#20928 ·
メンテナーはふだん 1 日以内に返信
-
automation documentation
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
SocialGouv/iterion#3287 ·
メンテナーはふだん 1 日以内に返信