[docs-scanner] Unclear pronoun reference in cloud delivery note
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 94/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- docker, markdown
- Domain
- documentation
Research direction
Open content/manuals/ai/governance/organization/audit/_index.md and read the cloud delivery note. Replace the ambiguous “It” with an explicit reference to cloud delivery, using one of the suggested phrasings. Done when the sentence clearly says cloud delivery does not add cloud sandbox coverage.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 139
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from docker/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
status/triage
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
[docs-scanner] Unclear policy change timing in organization policies overviewPossibly taken @Mhdomer claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 89/100
Maintainers usually reply within 1 day
-
Debian installation pitfallPossibly taken @Duo-ee claimed this 7 days ago. Openstatus/triage
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
Similar issues
-
Blog update untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 83/100
GSA/digital-gov-drupal#569 ·
Maintainers usually reply within 2 days