Addressing markdown lint#911
Open
neddp wants to merge 5 commits into
Open
Conversation
Contributor
|
Important Review skippedToo many files! This PR contains 218 files, which is 68 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (218)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
cf-foundation-community-automation
Bot
moved this to Inbox
in Foundational Infrastructure Working Group
There was a problem hiding this comment.
Pull request overview
This PR focuses on bringing the docs set into closer compliance with markdown lint/style expectations and ensuring previously-unlinked pages are reachable via the MkDocs navigation.
Changes:
- Normalize markdown structure across many pages (add missing H1s, fix list indentation, add spacing around thematic breaks, adjust code fences/language tags).
- Update MkDocs navigation to include previously-unused pages (
design.md,understanding-bosh.md,cli-env-deps.md). - Remove a few unused/obsolete pages (e.g.,
content/about.md,content/job-tmpfs.md,content/cli-help.md).
Reviewed changes
Copilot reviewed 218 out of 219 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds previously-unlinked pages to site nav |
| content/windows.md | Adds H1 + spacing/code fence tweaks |
| content/windows-sample-release.md | Adds H1 + spacing tweaks |
| content/warden-cpi.md | Adds H1 + list formatting cleanup |
| content/vsphere.md | Removes front-matter, normalizes lists, adds H1 |
| content/vsphere-vmotion-support.md | Adds H1 + list cleanup/link formatting |
| content/vsphere-network-partition.md | Adds H1 + improves list/code fence formatting |
| content/vsphere-migrate-datastores.md | Adds H1 + corrects code fence language |
| content/vsphere-human-readable-names.md | Adds H1 + improves YAML example formatting |
| content/vsphere-ha.md | Adds H1 + heading/list normalization |
| content/vsphere-esxi-host-failure.md | Adds H1 + restructures steps/output formatting |
| content/vsphere-cpi-errors.md | Adds H1 + converts quoted errors to fenced blocks |
| content/vm-struct.md | Adds H1 |
| content/vm-monit.md | Adds H1 + code fence/lint formatting updates |
| content/vm-anti-affinity.md | Adds H1 + list formatting cleanup |
| content/virtualbox-cpi.md | Adds H1 + list formatting cleanup |
| content/uploading-stemcells.md | Adds H1 + code fence language tweaks |
| content/uploading-releases.md | Adds H1 + fixes link/text formatting |
| content/update-cloud-config.md | Adds H1 |
| content/understanding-bosh.md | Adds H1 + list formatting cleanup |
| content/trusted-certs.md | Adds H1 + spacing tweaks |
| content/troubleshooting.md | Adds H1 + fixes typo (“pre-atart” → “pre-start”) |
| content/stemcell.md | Adds H1 + list/link formatting cleanup |
| content/snapshots.md | Adds H1 + inline-code formatting tweaks |
| content/scheduled-task-cleanup.md | Adds H1 + restructures headings/spacing |
| content/scheduled-procs.md | Adds H1 |
| content/sample-manifest.md | Adds H1 |
| content/s3-release-blobstore.md | Adds H1 + inline-code formatting cleanup |
| content/repack-stemcell.md | Adds H1 + list/code fence tweaks |
| content/remove-dev-tools.md | Adds H1 |
| content/release.md | Adds H1 |
| content/release-urls.md | Adds H1 + spacing tweaks |
| content/release-blobstore.md | Adds H1 + heading/list formatting cleanup |
| content/release-blobs.md | Adds H1 + spacing tweaks |
| content/recover.md | Adds H1 + list/code fence tweaks |
| content/recent.md | Adds H1 + list formatting cleanup |
| content/rackhd-cpi.md | Adds H1 |
| content/quick-start.md | Adds H1 + list spacing cleanup |
| content/props-common.md | Adds H1 + list formatting cleanup |
| content/problems.md | Adds H1 |
| content/pre-stop.md | Adds H1 + list/table formatting cleanup |
| content/pre-start.md | Adds H1 + spacing tweaks |
| content/post-stop.md | Adds H1 + spacing tweaks |
| content/post-start.md | Adds H1 + spacing tweaks |
| content/post-deploy.md | Adds H1 + spacing tweaks |
| content/persistent-disk-fs.md | Adds H1 |
| content/packages.md | Adds H1 + list indentation cleanup |
| content/package-vendoring.md | Adds H1 + wording/spacing improvements |
| content/openstack-vrrp.md | Adds H1 + code fence/list formatting cleanup |
| content/openstack-self-signed-endpoints.md | Adds H1 |
| content/openstack-registry.md | Adds H1 |
| content/openstack-multiple-networks.md | Adds H1 + heading/link formatting |
| content/openstack-light-stemcells.md | Adds H1 + heading normalization |
| content/openstack-keystonev2.md | Adds H1 |
| content/openstack-human-readable-vm-names.md | Adds H1 |
| content/openstack-cpi-errors.md | Adds H1 + converts quoted errors to fenced blocks |
| content/ntp-config.md | Fixes code fence language + spacing |
| content/noble-migration.md | Adds H1 + heading normalization/spacing |
| content/monitoring.md | Adds H1 + spacing + link text cleanup |
| content/migrated-from.md | Adds H1 + list formatting cleanup |
| content/mbus-ssl-rotation.md | Normalizes headings/lists |
| content/managing-stemcells.md | Adds H1 + spacing tweaks |
| content/managing-releases.md | Adds H1 + spacing/code fence tweaks |
| content/managed-networks.md | Adds H1 + code fence/lint formatting |
| content/locking-compiled-releases.md | Adds H1 + heading normalization |
| content/links-properties.md | Adds H1 + trailing spacing tweak |
| content/links-manual.md | Adds H1 |
| content/links-common-types.md | Adds H1 + list formatting cleanup |
| content/jumpbox.md | Adds H1 |
| content/job-tmpfs.md | Removes unused page |
| content/job-templates.md | Adds H1 |
| content/job-lifecycle.md | Adds H1 + list formatting consolidation |
| content/jammy-migration.md | Adds H1 + heading/code fence normalization |
| content/instance-metadata.md | Adds H1 + list formatting cleanup |
| content/init.md | Adds H1 |
| content/init-vsphere.md | Adds H1 |
| content/init-vsphere-rp.md | Adds H1 |
| content/init-google.md | Adds H1 |
| content/init-external-ip.md | Adds H1 |
| content/init-azure.md | Adds H1 + spacing tweaks |
| content/index.md | Removes extra blank lines |
| content/hm-config.md | Adds H1 + spacing tweaks |
| content/guide-ipv6-on-vsphere.md | Adds H1 |
| content/google.md | Removes front-matter + normalizes lists/table |
| content/google-required-permissions.md | Adds H1 + list numbering/formatting fixes |
| content/flush-arp.md | Adds H1 |
| content/events.md | Adds H1 + code fence language tweaks |
| content/errands.md | Adds H1 + spacing/code fence tweaks |
| content/drain.md | Adds H1 + list formatting/spacing tweaks |
| content/director-users.md | Adds H1 + spacing tweaks |
| content/director-users-uaa.md | Adds H1 + spacing tweaks |
| content/director-users-uaa-scopes.md | Adds H1 + spacing/code fence tweaks |
| content/director-tasks.md | Adds H1 + adjusts output/table formatting |
| content/director-configure-db.md | Adds H1 + spacing tweak |
| content/director-configure-blobstore.md | Adds H1 + spacing tweaks |
| content/director-certs.md | Adds H1 + spacing tweaks |
| content/director-certs-openssl.md | Adds H1 + spacing tweaks |
| content/director-bosh-teams.md | Adds H1 + code fence language tweaks |
| content/director-blobstore-signed-urls.md | Adds H1 + list/code fence formatting cleanup |
| content/director-backup.md | Adds H1 + converts inline commands to fenced blocks |
| content/director-access-events.md | Adds H1 + code fence language tweaks |
| content/design.md | Adds H1 + list formatting cleanup |
| content/deployment.md | Adds H1 |
| content/deployment-convergence.md | Adds H1 |
| content/deployment-basics.md | Adds H1 + list numbering tweak |
| content/deploying.md | Adds H1 + code fence language tweaks |
| content/deploying-step-by-step.md | Adds H1 + spacing tweaks |
| content/deploy-config.md | Adds H1 + spacing tweaks |
| content/creds-tmpfs.md | Adds H1 + list/code fence tweaks |
| content/credhub-encryption-password-rotation.md | Normalizes headings/lists |
| content/cpi-config.md | Adds H1 + code fence language/list cleanup |
| content/cpi-api-v3.md | List formatting cleanup |
| content/cpi-api-v3-method/create-stemcell.md | List formatting + JSON example indentation cleanup |
| content/cpi-api-v2-method/update-disk.md | List formatting cleanup |
| content/cpi-api-v2-method/snapshot-disk.md | List formatting cleanup |
| content/cpi-api-v2-method/set-vm-metadata.md | List formatting cleanup |
| content/cpi-api-v2-method/set-disk-metadata.md | List formatting cleanup |
| content/cpi-api-v2-method/resize-disk.md | List formatting cleanup |
| content/cpi-api-v2-method/reboot-vm.md | List formatting cleanup |
| content/cpi-api-v2-method/info.md | List formatting cleanup |
| content/cpi-api-v2-method/has-vm.md | List formatting cleanup |
| content/cpi-api-v2-method/has-disk.md | List formatting cleanup |
| content/cpi-api-v2-method/get-disks.md | List formatting cleanup |
| content/cpi-api-v2-method/detach-disk.md | List formatting + JSON example indentation cleanup |
| content/cpi-api-v2-method/delete-vm.md | List formatting cleanup |
| content/cpi-api-v2-method/delete-stemcell.md | List/link formatting cleanup |
| content/cpi-api-v2-method/delete-snapshot.md | List formatting cleanup |
| content/cpi-api-v2-method/delete-network.md | List formatting cleanup |
| content/cpi-api-v2-method/delete-disk.md | List formatting cleanup |
| content/cpi-api-v2-method/create-stemcell.md | List formatting + JSON example indentation cleanup |
| content/cpi-api-v2-method/create-network.md | Code fence language + list formatting tweaks |
| content/cpi-api-v2-method/create-disk.md | List formatting + typo cleanup |
| content/cpi-api-v2-method/calculate-vm-cloud-properties.md | List formatting cleanup |
| content/cpi-api-v2-method/attach-disk.md | List/JSON indentation cleanup |
| content/cpi-api-v1.md | Whitespace cleanup |
| content/cpi-api-v1-method/info.md | List formatting cleanup |
| content/cpi-api-v1-method/detach-disk.md | List formatting cleanup |
| content/cpi-api-v1-method/delete-vm.md | List formatting cleanup |
| content/cpi-api-v1-method/current-vm-id.md | List formatting cleanup |
| content/cpi-api-v1-method/create-vm.md | List/JSON indentation cleanup |
| content/cpi-api-v1-method/configure-networks.md | List formatting cleanup |
| content/cpi-api-v1-method/attach-disk.md | List/JSON indentation cleanup |
| content/configs.md | Fixes list marker/paragraph formatting + spacing |
| content/compiled-releases.md | Adds H1 + spacing tweaks |
| content/community.md | Spacing/list formatting cleanup |
| content/cli-v2-install.md | Spacing/list formatting cleanup |
| content/cli-v2-diff.md | Adds H1 + heading/table formatting cleanup |
| content/cli-tunnel.md | Adds H1 + heading normalization |
| content/cli-ops-files.md | Adds H1 + list/table formatting cleanup |
| content/cli-int.md | Adds H1 + heading spacing tweak |
| content/cli-help.md | Removes unused page |
| content/cli-global-flags.md | Adds H1 + spacing/code fence tweaks |
| content/cli-envs.md | Adds H1 + spacing tweaks |
| content/cli-env-deps.md | Adds H1 + spacing/code fence tweaks |
| content/changing-deployment-vm-strategy.md | Spacing/list formatting cleanup |
| content/cck.md | Adds H1 + spacing/list cleanup |
| content/bosh-lite.md | Adds H1 + list formatting cleanup |
| content/bosh-components.md | Adds H1 + list formatting cleanup |
| content/bosh-cli.md | Adds H1 + heading/code fence tweaks |
| content/blobstore-ca-rotation.md | List formatting cleanup + code fence language tweak |
| content/blobstore-agent-password-rotation.md | Adds H1 + heading/list normalization |
| content/basic-workflow.md | Adds H1 |
| content/azure.md | Removes front-matter + normalizes lists/table |
| content/azure-resources.md | Adds H1 + list formatting cleanup |
| content/azure-managed-identity.md | Adds H1 |
| content/azure-compute-gallery.md | Adds H1 + table formatting cleanup |
| content/aws.md | Removes front-matter + normalizes lists/table |
| content/aws-instance-storage.md | Adds H1 |
| content/aws-iam-users.md | Adds H1 |
| content/aws-iam-instance-profiles.md | Adds H1 + code fence language tweak |
| content/aws-cpi-errors.md | Adds H1 + spacing cleanup |
| content/alicloud-cpi-errors.md | Adds H1 + spacing cleanup |
| content/addons-common.md | Adds H1 + spacing tweaks |
| content/about.md | Removes unused page |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
github-project-automation
Bot
moved this from Inbox
to Pending Merge | Prioritized
in Foundational Infrastructure Working Group
aramprice
previously approved these changes
Jul 6, 2026
Ivaylogi98
previously approved these changes
Jul 7, 2026
Co-authored-by: ivaylogi98 <ivaylogi98@gmail.com>
neddp
dismissed stale reviews from Ivaylogi98, aramprice, and coderabbitai[bot]
via
68c4377
aramprice
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes markdown style issues. No data is changed.
Note, the following pages were unused and are now added to the nav: