[docs-scanner] Unclear pronoun reference in cloud delivery note
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 94/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- docker, markdown
調査の方向性
content/manuals/ai/governance/organization/audit/_index.mdを開き、クラウドデリバリーに関する注記を読んでください。曖昧な「It」を、提案されている表現のいずれかを使って、クラウドデリバリーを明示的に指す表現に置き換えてください。文が、クラウドデリバリーによってクラウドサンドボックスのカバレッジが追加されるわけではないことを明確に述べていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
File: content/manuals/ai/governance/organization/audit/_index.md
Issue
The note about cloud delivery contains an unclear pronoun reference:
Audit logs cover local sandboxes, the sandboxes that run on developers'
machines. Cloud delivery stores their audit records in the cloud. It
doesn't add cloud sandbox coverage.
The pronoun "It" in "It doesn't add cloud sandbox coverage" is ambiguous. Does "It" refer to "Cloud delivery" or to the entire audit logs feature?
Why this matters
A reader trying to understand what audit logs cover for cloud sandboxes will be confused about whether cloud delivery adds coverage for cloud sandboxes or whether audit logs as a whole don't cover cloud sandboxes.
Suggested fix
Clarify by using the explicit noun instead of the pronoun:
Audit logs cover local sandboxes, the sandboxes that run on developers'
machines. Cloud delivery stores their audit records in the cloud but
doesn't add cloud sandbox coverage.
Or restructure to make the relationship clearer:
Audit logs cover local sandboxes, the sandboxes that run on developers'
machines. Cloud delivery stores these local audit records in the cloud;
it doesn't extend coverage to cloud sandboxes.
Found by nightly documentation quality scanner
- 主要言語
- Markdown
- スター
- 4.7k
- フォーク
- 8.5k
- 平均マージ
- 2日 19時間
- マージ済み PR（30日）
- 156
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 89/100
メンテナーはふだん 1 日以内に返信
-
Debian installation pitfall対応中かも @Duo-ee が 6 日前に担当しました。 オープンstatus/triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
Confusing and contradictory information about paths resolving in extend対応中かも @Duo-ee が 5 日前に担当しました。 オープンstatus/triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
[docs-scanner] Inconsistent terminology: 'nested organization' vs 'organization in the company'対応中かも @dave123981 が 7 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
Outdated Java language-specific guide: deprecated code in Dockerfile, compose.yaml mistyped name, Spring Boot localization variables.対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンstatus/triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
docker/docs#26484 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
documentation enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
good first issue priority:low type:docs
難易度 1/5 1〜3時間 初心者へのやさしさ 95/100
crazy-goat/rabbit-stream#969 ·
メンテナーはふだん 1 日以内に返信
-
question
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
backend docs
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
Open-Locker/Open-Locker#368 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
fsprojects/FSharp.Formatting#1370 ·
メンテナーはふだん 1 日以内に返信