Skip to content

READMEs: cleanup spelling, formatting; delete outdated docs#2712

Merged
rkoster merged 1 commit intomainfrom
cleanup-readmes
Apr 23, 2026
Merged

READMEs: cleanup spelling, formatting; delete outdated docs#2712
rkoster merged 1 commit intomainfrom
cleanup-readmes

Conversation

@aramprice
Copy link
Copy Markdown
Member

The deleted items were either out of date, or incorrect, or both.

The deleted items were either out of date, or incorrect, or both.
@aramprice aramprice requested review from a team, a-hassanin and fmoehler and removed request for a team April 16, 2026 22:11
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

Walkthrough

This pull request consolidates and refactors project documentation. It removes several deprecated documentation files including code style guidelines, workstation setup instructions, pull request workflow procedures, and director console debugging steps for versions 265.x and earlier. Docker Compose configuration for local database services and duplicate database schema documentation are also removed. The remaining documentation receives formatting improvements, including table alignment adjustments, typo corrections (such as "heatbeat" to "heartbeat" and "reciept" to "receipt"), and wording refinements. Documentation references are streamlined by removing links to hotfix and manual release workflows.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is significantly incomplete, lacking required sections from the template such as contextual information, test results, release notes, breaking change assessment, and team tags. Add comprehensive information for each template section: explain what was outdated/incorrect, provide test confirmation, write release notes, clarify if this is a breaking change, and tag relevant team members.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: cleanup of spelling and formatting in READMEs and removal of outdated documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cleanup-readmes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/README.md`:
- Around line 17-21: Remove the dangling fragment "There have been" and replace
it with a complete sentence in the schema section (for example, merge it into or
replace with "Steps to generate the schema:"), and fix the hyphenation by
changing "Right click database connection" to "Right-click database connection"
so the lines containing "There have been", "Steps to generate:", and "Right
click database connection" are corrected and read smoothly.

In `@README.md`:
- Around line 3-4: Update the README intro wording: change “open source” to
“open-source” in the sentence starting with “Cloud Foundry BOSH is an open
source tool…”, and standardize the phrasing/capitalization on the repo list line
that currently references line 34 by ensuring it uses “repository” (lowercase r)
and “BOSH” (all-caps) consistently; apply these copy edits so the intro and the
repo list use “open-source”, “repository”, and “BOSH” with consistent
capitalization and style.

In `@src/bosh-monitor/lib/bosh/monitor/plugins/README.md`:
- Line 21: Fix the typos in the Consul options table in README.md: change the
term "protocal" to "protocol" and change "real time" to "real-time" (leave "as
events" as-is). Update the table cells containing those exact strings so both
occurrences are corrected.

In `@src/bosh-monitor/README.md`:
- Around line 129-130: Replace the hardcoded absolute URLs pointing to the repo
tree for the plugin authoring steps with branch-agnostic relative links: change
the link targets in the lines mentioning "Create a `plugin.rb` for your plugin
extension" and "Create a matching test file for your plugin extension `spec.rb`"
(and the same occurrences later) to use relative paths (e.g.,
./lib/bosh/monitor/plugins and ./spec/unit/bosh/monitor/plugins) instead of URLs
containing "master" so the docs remain valid across branches.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5dc35b1d-e82d-417f-999c-4b4d67f89cb4

📥 Commits

Reviewing files that changed from the base of the PR and between c70527f and 878eea8.

⛔ Files ignored due to path filters (2)
  • docs/director_schema/bosh-db-diagram.png is excluded by !**/*.png
  • docs/director_schema/bosh-db-diagram.svg is excluded by !**/*.svg
📒 Files selected for processing (11)
  • README.md
  • docs/README.md
  • docs/code_style.md
  • docs/director-console-debugging.md
  • docs/director_schema/README.md
  • docs/docker-compose.yml
  • docs/ip_reservation_flow.md
  • docs/pull_request_workflow.md
  • docs/workstation_setup.md
  • src/bosh-monitor/README.md
  • src/bosh-monitor/lib/bosh/monitor/plugins/README.md
💤 Files with no reviewable changes (6)
  • docs/director_schema/README.md
  • docs/director-console-debugging.md
  • docs/pull_request_workflow.md
  • docs/code_style.md
  • docs/docker-compose.yml
  • docs/workstation_setup.md

Comment thread docs/README.md
Comment thread README.md
Comment thread src/bosh-monitor/lib/bosh/monitor/plugins/README.md
Comment thread src/bosh-monitor/README.md
Copy link
Copy Markdown
Member

@neddp neddp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@rkoster rkoster merged commit be1d27f into main Apr 23, 2026
22 checks passed
@github-project-automation github-project-automation Bot moved this from Pending Merge | Prioritized to Done in Foundational Infrastructure Working Group Apr 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

5 participants