Skip to content

Add core dump documentation and improve docs structure and accuracy#903

Open
hoffmaen wants to merge 4 commits intocloudfoundry:masterfrom
sap-contributions:core-dump-docu
Open

Add core dump documentation and improve docs structure and accuracy#903
hoffmaen wants to merge 4 commits intocloudfoundry:masterfrom
sap-contributions:core-dump-docu

Conversation

@hoffmaen
Copy link
Copy Markdown
Contributor

@hoffmaen hoffmaen commented Apr 22, 2026

  • Add docs/coredumps.md documenting how to enable core dumps for HAProxy debugging
  • Restructure README.md with a documentation index linking all files in docs/
  • Fix spelling, grammar, and formatting issues across all documentation files
  • Correct inaccurate property name (backend_ca -> backend_ca_file) in mutual_tls.md
  • Fix incorrect config examples in rate_limiting.md (remove non-existent parameters, replace ERB tag with rendered value)

@maxmoehl
Copy link
Copy Markdown
Member

maxmoehl commented Apr 23, 2026

Please check your git config, somehow you committed with the identity of a bot user?

Otherwise the content looks good. I've also dropped a PR to BPM for this: cloudfoundry/bpm-release#217

@plowin plowin added the run-ci Allow this PR to be tested on Concourse label Apr 24, 2026
plowin
plowin previously approved these changes Apr 24, 2026
Copy link
Copy Markdown
Contributor

@plowin plowin left a comment

Choose a reason for hiding this comment

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

thx for also cleaning up!
Minor suggestion could also be addressed via follow-up issue if you prefer.

Comment thread docs/coredumps.md Outdated

Enabling core dumps requires the following modifications to the BOSH release:

### 1. Disable BPM
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We could split this into either 1a. disable or 1b. use https://github.com/cloudfoundry/bpm-release/pull/217/changes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Split into 1a and 1b.

@github-project-automation github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Application Runtime Platform Working Group Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

run-ci Allow this PR to be tested on Concourse

Projects

Status: Pending Merge | Prioritized

Development

Successfully merging this pull request may close these issues.

3 participants