Document the Crossplane project file (and the new pre-built function and per-language schema options)
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 65/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 領域
- cli, documentation
調査の方向性
CLI コマンドリファレンスと Configurations の packaging ドキュメントから始め、その後、crossplane/docs#1104 におけるバージョン付き CLI ドキュメントの再構成を考慮します。ProjectSpec、Directory、Tarball の各関数と、言語ごとのスキーマ生成を、例および影響を受ける workflow へのリンク付きでカバーする project-file reference があれば完了です。
索引モデルが issue の本文から書いたものです。
説明
What's Missing?
The Crossplane CLI's project workflow (crossplane project init/build/run) is configured by a project file — a Project resource whose spec (ProjectSpec) controls the repository, dependencies, paths, target architectures, embedded functions, and schema generation. Today this file has no prose documentation. The only place any of it surfaces is the auto-generated CLI command reference, which documents command flags but not the project file's schema. The packaging docs (Configurations) only cover the older crossplane xpkg build + crossplane.yaml flow, not the newer Projects flow.
crossplane/cli#24 just merged and adds two new optional ProjectSpec fields that need documenting:
1. Pre-built function runtimes (spec.functions) — fixes crossplane/cli#21. An explicit list of functions to build, which disables the default per-subdirectory auto-discovery. Each entry uses a source discriminator (Directory or Tarball). Tarball sources skip language detection and load a pre-built single-platform OCI image tarball per target architecture (<pathPrefix>-<arch>.tar/.tar.gz), so projects can build functions with their own toolchain (make, Nix, Bazel, ko, docker save, etc.).
spec:
architectures: [amd64, arm64]
functions:
- source: Directory
directory:
name: function-a
- source: Tarball
tarball:
name: function-b
pathPrefix: build/function-b
2. Per-language schema generation (spec.schemas.languages) — fixes crossplane/cli#29. Restricts schema generation to a subset of the supported languages (Go, JSON, KCL, Python) instead of generating all four. Applies to both the project's own XRDs and its dependencies, and flows through project build/run and dependency update-cache/clean-cache.
spec:
schemas:
languages: [python]
Ideally these are documented as part of a broader project-file reference page rather than in isolation, since the project file itself is currently undocumented.
Note the CLI docs are mid-restructure (crossplane/docs#1104 moves them into their own versioned tree and gives them a separate sidebar/version menu), so placement should account for that.
- 主要言語
- SCSS
- スター
- 60
- フォーク
- 163
- 平均マージ
- 5日 6時間
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
crossplane/docs のほかの issue
-
docs: fix 'allows to use' grammar in Composition compositeTypeRef note対応中かも @mrchatam が 23 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
crossplane/docs#1154 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
crossplane/docs#1153 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
crossplane/docs#1139 ·
-
[Web Bug] - Managed Resource Activation Policies対応中かも @boxcee-interview が 78 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
crossplane/docs#1126 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
crossplane/docs#1121 ·
crossplane/docs の issue をすべて見る
似ている issue
-
[Request]: zbarオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
ScoopInstaller/Extras#18939 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
CommandCodeAI/command-code#992 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
gugod/App-perlbrew#879 ·
-
fix(mcp): avoid Unicode credential masking panics in profile_show対応中かも @joshrotenberg が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 4 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信