SURVEY-FIXES.csv

Section,ID,Repo,File,Line(s),Description,Suggested Fix,Action,Notes
,,,,,,,,
,,HOW TO USE:,,,,,
,,"- Action values: fix | archive | review | skip",,,,,
,,"- fix = make the change as described",,,,,
,,"- archive = move file to archive/ folder and remove TOC/index references",,,,,
,,"- review = you need to look at the file before deciding",,,,,
,,"- skip = do nothing",,,,,
,,"- When ready tell the AI: 'Work through SURVEY-FIXES.csv and fix everything marked fix'",,,,,
,,,,,,,,
1 - Typos,ID,Repo,File,Line(s),Description,Suggested Fix,Action,Notes
,TYP-01,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,25,"""a new version instances""","Change to ""new version instances"" (or ""the new version's instances"")","",
,TYP-02,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,77,"""MaxInFlight number of instance from the old web process""","Change ""instance"" to ""instances""","",
,TYP-03,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,92,"Redundant phrase: ""of the web process's instances of the web process"" — second occurrence is a duplicate",Delete the second ""of the web process"","",
,TYP-04,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,384,"Missing opening quote in JSON: ""guid"": PACKAGE-GUID""","Change to ""guid"": ""PACKAGE-GUID""","",
,TYP-05,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,"403, 516","Unquoted placeholder string in JSON: ""strategy"": STRATEGY","Change to ""strategy"": ""STRATEGY"" (both occurrences)","",
,TYP-06,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,502,"""to restart simultaneous until""","Change ""simultaneous"" to ""simultaneously""","",
,TYP-07,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,"514, 523","Unquoted placeholder strings in JSON: ""guid"": DROPLET-GUID and ""guid"": APP-GUID",Add surrounding double-quotes to both placeholder values,"",
,TYP-08,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,533,MAX_IN_FLIGH — truncated variable name,Change to MAX_IN_FLIGHT,"",
,TYP-09,docs-cf-admin,stack-auditor.html.md.erb,220,"Link text ends with ""Ubuntu 22.04re"" — URL fragment corrupted into label","Fix link text to end at ""Ubuntu 22.04""","",
,TYP-10,docs-cf-admin,distributed-tracing.html.md.erb,114,"""originiating""",Change to ""originating"","",
,TYP-11,docs-cf-admin,routing-keepalive.html.md.erb,26,"""Gorouter must be reponsible""",Change to ""responsible"","",
,TYP-12,docs-cf-admin,configuring-delayed-job-priorities.html.md.erb,11,"""DELETE v3/buildbacks/[GUID]"" — ""buildbacks"" is not a CF API resource","Change ""buildbacks"" to ""buildpacks""","",
,TYP-13,docs-cf-admin,configuring-delayed-job-priorities.html.md.erb,16,"States job priority 1 runs before priority 0 — contradicts the rule that higher numbers = lower priority (1 should run AFTER 0, not before)","Change ""before"" to ""after""","",
,TYP-14,docs-cf-admin,configuring-delayed-job-priorities.html.md.erb,29,"""you can view a jobs that have been delayed""","Change ""a jobs"" to ""jobs""","",
,TYP-15,docs-cf-admin,extended-app-support-old.html.md.erb,30,"Step 5 says ""Apply Changes to migrate to cflinuxfs3"" — factually backwards; this step applies the cflinuxfs4-only change","Reword to: ""Click Apply Changes to apply the stack configuration update.""","",
,TYP-16,docs-deploying-cf,migrating.html.md.erb,"218–219","Cloud config YAML example has two AZ entries both named z1; the second should be z2",Change second name: z1 to name: z2,"",
,TYP-17,docs-running-cf,index.html.md.erb,17,"Link text says ""Tanzu UAA audit requirements"" but topic has no ""Tanzu"" prefix",Remove ""Tanzu"" from link text,"",
,,,,,,,,
2 - HTML / Markdown / ERB Errors,ID,Repo,File,Line(s),Description,Suggested Fix,Action,Notes
,HTML-01,docs-book-cloudfoundry,master_middleman/source/subnavs/_cf-subnav.erb,197–212,"<li class=""has_submenu""> for ""How to push your app"" (line 197) is missing its closing </li> after its </ul> (line 211)",Add </li> after line 211's </ul>,"",
,HTML-02,docs-book-cloudfoundry,master_middleman/source/subnavs/_cf-subnav.erb,360–392,"Information for Managed Service Authors section uses <li><strong> with a child <ul> — inconsistent with AGENTS.md convention","Convert to <li class=""has_submenu""><span>Information for Managed Service Authors</span><ul>...</ul></li>","",
,HTML-03,docs-book-cloudfoundry,master_middleman/source/subnavs/_cf-subnav.erb,408–409,"Two API reference links use http:// instead of https://: v2-apidocs and v3-apidocs URLs",Change both to https://,"",
,HTML-04,docs-book-cloudfoundry,master_middleman/source/subnavs/_cf-subnav.erb,400,Broken link: /uaa/uaa-deploy.html — file uaa-deploy.html.md.erb does NOT exist in docs-uaa,"Remove the link or create the missing file (see TOC-17)","",
,HTML-05,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,430–435,"Cancel a deployment CLI block is a dangling indented code block, not inside a numbered list item",Wrap in a numbered list item consistent with the rest of the procedure,"",
,HTML-06,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,440,"Stray unmatched quote at end of URL: cf curl .../actions/cancel"" -X POST",Remove trailing quote character,"",
,HTML-07,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,462–465,Continue a canary deployment CLI block has same dangling structure as HTML-05,Apply same fix as HTML-05,"",
,HTML-08,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,470,"Same stray trailing quote as HTML-06: cf curl .../actions/continue"" -X POST",Remove trailing quote character,"",
,HTML-09,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,482–491,Restart an app CLI block has same dangling structure as HTML-05,Apply same fix as HTML-05,"",
,HTML-10,docs-cf-admin,stack-auditor.html.md.erb,"212, 222","Two <a id=""dotnet-gss""> anchors have identical IDs — second anchor (.NET Core apps and LDAP) is unreachable","Change second anchor ID to ""dotnet-ldap""","",
,HTML-11,docs-cf-admin,stack-auditor.html.md.erb,220,Two href values missing quotation marks: <a href=https://...> (two occurrences),"Add quotes: href=""https://...""","",
,HTML-12,docs-cf-admin,extended-app-support-old.html.md.erb,28,"[cflinuxfs4-only](./images/cflinuxfs3_upgrade.png) renders as a hyperlink not an image — missing !","Change to ![cflinuxfs4-only](./images/cflinuxfs3_upgrade.png)","",
,HTML-13,docs-deploying-cf,max-container-starts.html.md.erb,28,"<p class=""terminal""> — uses <p> instead of <pre class=""terminal""> for terminal output","Change to <pre class=""terminal""> and add closing </pre>","",
,HTML-14,docs-running-cf,config-cell-cleanup.html.md.erb,59,Raw HTML &nbsp; entities in plain Markdown text — renders as literal &nbsp; in some toolchains,Rewrite math expression as plain text or inside a <code> element,"",
,HTML-15,docs-running-cf,trusted-system-certificates.html.md.erb,1–3,Front matter missing owner: field present in nearly all other topics,"Add owner: field (e.g. owner: Diego)","",
,HTML-16,docs-dev-guide,deploy-apps/rolling-deploy.html.md.erb,54–82,"Numbered list in Canary Deployments section restarts at 1 twice and 2 twice — outer sequence should continue as steps 3 and 4",Renumber outer list items to continue sequentially,"",
,,,,,,,,
3 - Factual / Presentation Inconsistencies,ID,Repo(s),File(s),Line(s),Description,Suggested Fix,Action,Notes
,INC-01,"docs-cf-admin, docs-dev-guide","managing-stacks.html.md.erb, deploy-apps/stacks.html.md.erb",,RESTRICTED state and restaging: managing-stacks says RESTRICTED still allows restaging; stacks.html omits restaging from RESTRICTED allowed-operations. One is wrong.,Reconcile the two topics so both say the same thing,"",
,INC-02,docs-running-cf,trusted-system-certificates.html.md.erb,,"Topic documents only cflinuxfs3 trusted cert config; cflinuxfs4 guidance is absent. Default stack is now cflinuxfs4.",Add cflinuxfs4 guidance to the topic,"",
,INC-03,docs-running-cf,index.html.md.erb,14,"[Managing users](../operating/t-uaa/uaa-user-management.html) — TAS-specific path that 404s in the OSS CF book",Change path to /uaa/uaa-user-management.html,"",
,INC-04,docs-cf-admin,notifications.html.md.erb,27,"../operating/cf-cli/install-cf-cli.html — TAS-specific path for cf CLI install that 404s in the OSS CF book",Change to /cf-cli/install-go-cli.html,"",
,INC-05,docs-cf-admin,distributed-tracing.html.md.erb,31,"B3 single-header described as only a combination of X-B3-Traceid and X-B3-Spanid — incomplete; B3 also carries trace flags",Expand description to mention the trace flags field,"",
,INC-06,docs-cf-admin,configuring-delayed-job-priorities.html.md.erb,,"Self-contradictory priority explanation (see also TYP-13) — verify full paragraph is internally consistent after TYP-13 fix",Review full paragraph after TYP-13 is applied,"",
,INC-07,docs-cf-admin,"extended-app-support.html.md.erb, extended-app-support-old.html.md.erb",,"Two files with identical titles covering overlapping content (10.2.1+ vs 10.2.2+); -old file is unreferenced from subnav and appears to be a superseded draft","Decide: delete -old, or rename it clearly as historical","",
,INC-08,docs-book-cloudfoundry,master_middleman/source/subnavs/_cf-subnav.erb,"7, 66, 360","Three section headings use inconsistent HTML patterns. Lines 7 and 66: <li><strong>text</strong></li> (no children). Line 360: <li><strong> with child <ul> inside same <li>. AGENTS.md requires <li class=""has_submenu""><span> for sections with children.",Normalize all three headings to consistent pattern (see HTML-02 for line 360),"",
,,,,,,,,
4a - Topics Previously in Subnav (removed — restore or archive?),ID,Repo,File,TOC Path,Last Subnav Title,Removed Intentionally?,Action,Notes
,TOC-01,docs-cf-admin,bbs-encryption-keys.html.md.erb,/adminguide/bbs-encryption-keys.html,Bulletin Board System (BBS) Data Store Encryption,No explicit reason in commit,"",
,TOC-02,docs-cf-admin,routing-keepalive.html.md.erb,/adminguide/routing-keepalive.html,Router Back-End Keepalive Connections,No explicit reason in commit,"",
,TOC-03,docs-running-cf,trusted-system-certificates.html.md.erb,/running/trusted-system-certificates.html,Configuring Trusted System Certificates for Applications,No explicit reason in commit,"",
,TOC-04,docs-running-cf,setting-rate-limit-cloud-api.html.md.erb,/running/setting-rate-limit-cloud-api.html,Setting the Rate Limit for the Cloud Controller API,No explicit reason in commit,"",
,TOC-05,docs-running-cf,deploy-vol-services.html.md.erb,/running/deploy-vol-services.html,Adding Volume Services to your Deployment,No explicit reason in commit,"",
,TOC-06,docs-running-cf,cf-api-endpoint.html.md.erb,/running/cf-api-endpoint.html,Identifying your Cloud Foundry API Endpoint and Version,No explicit reason in commit,"",
,TOC-07,docs-deploying-cf,max-container-starts.html.md.erb,/deploying/max-container-starts.html,Setting a Maximum Number of Started Containers (was at /adminguide/ path — file has since moved),No explicit reason in commit,"",
,TOC-08,docs-buildpacks,developing-buildpacks.html.md.erb,/buildpacks/developing-buildpacks.html,Customizing and developing buildpacks in Cloud Foundry,YES — commit says topic combined with custom.html,"",
,TOC-09,docs-deploying-cf,migrating.html.md.erb,/deploying/migrating.html,Migrating from cf-release to cf-deployment,YES — commit says remove cf-release migration topic - 7 years old,"",
,TOC-10,docs-buildpacks,java/bosh_custom_trusted_certs.html.md.erb,/buildpacks/java/bosh_custom_trusted_certs.html,BOSH Custom Trusted Certificate Support (was under Java buildpack section),No explicit reason in commit,"",
,,,,,,,,
4b - Topics Never in Subnav (review before deciding),ID,Repo,File,TOC Path,Notes on File,,,
,TOC-11,docs-running-cf,custom-stack.html.md.erb,/running/custom-stack.html,Added to repo but never in subnav. Cross-referenced from stacks.html.md.erb as where to learn about custom stacks.,,,
,TOC-12,docs-buildpacks,sidecar-buildpacks.html.md.erb,/buildpacks/sidecar-buildpacks.html,Added to repo but never surfaced in subnav.,,,
,TOC-13,docs-buildpacks,system-buildpacks.html.md.erb,/buildpacks/system-buildpacks.html,Added to repo but never surfaced in subnav.,,,
,TOC-14,docs-buildpacks,hwc/extension-buildpack.html.md.erb,/buildpacks/hwc/extension-buildpack.html,Added to repo (moved from .NET Core section) but never surfaced in subnav.,,,
,TOC-15,docs-buildpacks,hwc/web-config-transform-buildpack.html.md.erb,/buildpacks/hwc/web-config-transform-buildpack.html,Added to repo but never surfaced in subnav.,,,
,TOC-16,docs-deploying-cf,cf-release-eol.html.md.erb,/deploying/cf-release-eol.html,Added to repo but never surfaced in subnav. Referenced internally from migrating.html.,,,
,TOC-17,docs-uaa,uaa-deploy.html.md.erb,/uaa/uaa-deploy.html,FILE DOES NOT EXIST. Subnav has a live broken link to it (Deploy UAA). File must be created or link removed. See also HTML-04.,,,