Clarify default channel behavior when no channels field is specified in ImageSetConfiguration
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 85/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
調査の方向性
oc-mirror-operator-catalog-filtering.adoc を開き、Scenario 3 を見つけます。周辺のオペレータカタログのフィルタリングに関するガイダンスを読み、チャネルが指定されていない場合にすべてのチャネルが含まれることを明示し、特定のチャネルを選択する方法を説明するように文言を更新します。デフォルトのスコープとフィルタリングオプションが曖昧でなければ完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
The documentation for oc-mirror v2 operator catalog filtering (module oc-mirror-operator-catalog-filtering.adoc) does not explicitly state that when no channels: field is specified for an operator package in the ImageSetConfiguration, all channels of that package are included in the mirroring set.
Current wording (Scenario 3)
The current text reads:
"One bundle, corresponding to the head version for each channel of that package."
While this is technically accurate, the phrase "each channel" only implies that all channels are included. Users have to read carefully to understand this — it is easy to misinterpret as meaning only the default channel is mirrored.
Suggested improvement
Add an explicit clarification, for example:
"When no
channelsfield is specified for a package, oc-mirror includes all channels of that package and mirrors the head bundle from each one. To mirror only specific channels, add achannelsblock listing the desired channel names."
This would help users understand the potentially large scope of an unfiltered package specification and make an informed decision about whether to add explicit channel filters.
Context
This came up during a support discussion where the behavior was initially misunderstood. The oc-mirror team confirmed that the default is to mirror all channels when no channels: field is specified.
- 主要言語
- HTML
- スター
- 882
- フォーク
- 2k
- 平均マージ
- 7時間 20分
- マージ済み PR（30日）
- 826
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openshift/openshift-docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
openshift/openshift-docs#120791 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
openshift/openshift-docs#120489 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
openshift/openshift-docs#120356 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
openshift/openshift-docs#119965 ·
メンテナーはふだん 1 日以内に返信
-
lifecycle/stale
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
openshift/openshift-docs#112917 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
openshift/openshift-docs の issue をすべて見る
似ている issue
-
[Sync EN] Fix session read handler docs: false reports a failure, not a missing session (#5902)オープンsync-en
難易度 2/5 1〜2日 初心者へのやさしさ 84/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
unixorn/awesome-zsh-plugins#2285 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
astrodbtoolkit/astrodb-bot#105 ·