Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/review |
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
This PR reorganizes admin documentation pages but introduces a critical URL issue and several broken anchors.
Summary of findings:
- 🔴 CRITICAL: Directory named
Setup(capital S) with Hugo'sdisablePathToLower: truewill cause 404s for all lowercase/setup/cross-references - 🟡 MEDIUM: TOC in insights.md misleadingly labeled under "following charts:"
- 🟡 MEDIUM: 4 broken anchors in updated links (#export-members, #remove-a-member-or-invitee, #view-docker-product-usage)
| --- | ||
| build: | ||
| render: never | ||
| title: Setup |
There was a problem hiding this comment.
[HIGH] Case mismatch: directory Setup vs lowercase setup links will cause 404s
Hugo is configured with disablePathToLower: true in hugo.yaml, which means URL paths preserve the filesystem case. This directory is named Setup (capital S), so Hugo will generate URLs like /admin/organization/Setup/onboard/, /admin/organization/Setup/orgs/, etc.
However, all cross-references in this PR and in content/manuals/admin/organization/_index.md use lowercase /admin/organization/setup/.... With case-sensitive URL resolution, these links will produce 404 errors in production.
The sibling directory manage/ is correctly all-lowercase. To fix, rename the directory from Setup/ to setup/ before merging.
| - [Docker Desktop usage](#docker-desktop-usage) | ||
| - [Docker Hub images](#docker-hub-images) | ||
| - [Extensions](#extensions) | ||
| - [Prerequisites](#prerequisites) |
There was a problem hiding this comment.
[MEDIUM] TOC placed under misleading heading "Insights data is displayed in the following charts:"
The new table of contents links (Prerequisites, Export Docker Desktop user data, Understanding export data, Troubleshoot Insights) are listed under the sentence: Insights data is displayed in the following charts:
None of these new TOC entries are charts. This is misleading — readers expecting charts will instead find prerequisites, export instructions, and troubleshooting. Consider changing the intro sentence to something like This page covers the following topics: or placing the chart list separately.
| ### Bug fixes and enhancements | ||
|
|
||
| - You can now [export a CSV file of members](../admin/organization//members.md#export-members) from organizations that you own. | ||
| - You can now [export a CSV file of members](../admin/organization/manage/members.md#export-members) from organizations that you own. |
There was a problem hiding this comment.
[MEDIUM] Broken anchor #export-members — should be #export-members-csv-file
The link ../admin/organization/manage/members.md#export-members uses an anchor that does not exist. The actual section heading in members.md is ## Export members CSV file, which generates the anchor #export-members-csv-file.
Users clicking this link will land at the top of the page instead of the export section. This anchor was already broken before the path update — the refactor is an opportunity to fix it.
Suggested fix: ../admin/organization/manage/members.md#export-members-csv-file
| ## Can I export a list of users with their roles and privileges? | ||
|
|
||
| Yes, use the [Export Members](../../admin/organization/members.md#export-members) feature to export a CSV file containing your organization's users with role and team information. | ||
| Yes, use the [Export Members](../../admin/organization/manage/members.md#export-members) feature to export a CSV file containing your organization's users with role and team information. |
There was a problem hiding this comment.
[MEDIUM] Broken anchor #export-members — should be #export-members-csv-file
The link ../../admin/organization/manage/members.md#export-members uses an anchor that doesn't exist. The section heading in members.md is ## Export members CSV file, generating #export-members-csv-file.
Suggested fix: ../../admin/organization/manage/members.md#export-members-csv-file
| ## Is Docker SSO fully synced with the IdP? | ||
|
|
||
| Docker SSO provides Just-in-Time (JIT) provisioning by default. Users are provisioned when they authenticate with SSO. If users leave the organization, administrators must manually [remove the user](/manuals/admin/organization/members.md#remove-a-member-or-invitee) from the organization. | ||
| Docker SSO provides Just-in-Time (JIT) provisioning by default. Users are provisioned when they authenticate with SSO. If users leave the organization, administrators must manually [remove the user](/manuals/admin/organization/manage/members.md#remove-a-member-or-invitee) from the organization. |
There was a problem hiding this comment.
[MEDIUM] Broken anchor #remove-a-member-or-invitee — no matching heading in members.md
The link /manuals/admin/organization/manage/members.md#remove-a-member-or-invitee references an anchor that doesn't exist. The relevant sections in members.md are ### Remove an invitation (→ #remove-an-invitation) and ### Remove members from teams (→ #remove-members-from-teams).
This was a pre-existing issue, but the path refactor is an opportunity to correct it.
| - Testcontainers Cloud runtime minutes | ||
|
|
||
| To understand your usage patterns, [view your consumption](../admin/organization/manage-products.md#view-docker-product-usage) at any time. | ||
| To understand your usage patterns, [view your consumption](../admin/organization/manage/manage-products.md#view-docker-product-usage) at any time. |
There was a problem hiding this comment.
[MEDIUM] Broken anchor #view-docker-product-usage — should be #monitor-product-usage-for-your-organization
The link ../admin/organization/manage/manage-products.md#view-docker-product-usage references an anchor that doesn't exist. The section heading in manage-products.md is ## Monitor product usage for your organization, which generates #monitor-product-usage-for-your-organization.
Suggested fix: ../admin/organization/manage/manage-products.md#monitor-product-usage-for-your-organization
1 participant
PR to capture work: