docs: Standardize terminology and add code block language tags#39
Merged
Conversation
Phase 2 & 3 of documentation cleanup plan - improved consistency, readability, and syntax highlighting across 16 documentation files. **Phase 2 - Terminology Standardization:** - Replaced 100+ instances of "Postgres" with "PostgreSQL" for brand consistency - Preserved "Trusted Postgres Architect" (official product name) - Preserved lowercase "postgres" in technical contexts (users, namespaces, commands) - Standardized "datacenter" (one word) throughout - Ensured consistent DC1/DC2 capitalization - Expanded first AAP mentions to "Ansible Automation Platform (AAP)" **Phase 3 - Code Block Language Tags:** - Added language tags to 40+ code blocks for proper syntax highlighting - Tagged shell commands with ```bash - Tagged output examples with ```text - Tagged configuration files with ```ini, ```properties - Tagged diagrams with ```text **Files modified (16):** - User-facing: quick-start-guide.md, troubleshooting.md - Operational: dr-testing-guide.md, scripts-guide.md, manual-scripts-doc.md - Deployment: install-kubernetes-manual.md, install-tpa.md, install-rhel-manual.md - Architecture: architecture.md, aap-openshift-dr-architecture.md - Reference: aap-components-reference.md, aap-containerized-*.md - Validation: dr-replication-validation-report.md, split-brain-prevention.md - Testing: openshift-edb-operator-smoke-test.md, haproxy-pgbouncer-*.md **Quality improvements:** - Removed emoji/checkmarks from tables for better accessibility - Improved professional presentation - Enhanced searchability with consistent terminology - Better syntax highlighting for code examples **Excluded (as requested):** - docs/aap-containerized-enterprise-dr-architecture.md (not modified) Standards compliance: CONTRIBUTING.md, CLAUDE.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
chadmf
added a commit
that referenced
this pull request
Apr 17, 2026
* docs: Standardize terminology and add code block language tags Phase 2 & 3 of documentation cleanup plan - improved consistency, readability, and syntax highlighting across 16 documentation files. **Phase 2 - Terminology Standardization:** - Replaced 100+ instances of "Postgres" with "PostgreSQL" for brand consistency - Preserved "Trusted Postgres Architect" (official product name) - Preserved lowercase "postgres" in technical contexts (users, namespaces, commands) - Standardized "datacenter" (one word) throughout - Ensured consistent DC1/DC2 capitalization - Expanded first AAP mentions to "Ansible Automation Platform (AAP)" **Phase 3 - Code Block Language Tags:** - Added language tags to 40+ code blocks for proper syntax highlighting - Tagged shell commands with ```bash - Tagged output examples with ```text - Tagged configuration files with ```ini, ```properties - Tagged diagrams with ```text **Files modified (16):** - User-facing: quick-start-guide.md, troubleshooting.md - Operational: dr-testing-guide.md, scripts-guide.md, manual-scripts-doc.md - Deployment: install-kubernetes-manual.md, install-tpa.md, install-rhel-manual.md - Architecture: architecture.md, aap-openshift-dr-architecture.md - Reference: aap-components-reference.md, aap-containerized-*.md - Validation: dr-replication-validation-report.md, split-brain-prevention.md - Testing: openshift-edb-operator-smoke-test.md, haproxy-pgbouncer-*.md **Quality improvements:** - Removed emoji/checkmarks from tables for better accessibility - Improved professional presentation - Enhanced searchability with consistent terminology - Better syntax highlighting for code examples **Excluded (as requested):** - docs/aap-containerized-enterprise-dr-architecture.md (not modified) Standards compliance: CONTRIBUTING.md, CLAUDE.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * docs: Update CHANGELOG.md with recent documentation improvements Added entries for: - PR #39: Documentation cleanup and standardization (16 files, 100+ terminology fixes) - PR #38: CLAUDE.md and AAP OpenShift DR architecture documentation Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * docs: Complete cleanup batches 5 & 6 - validation, architecture, and reference docs Extended Phase 2 & 3 cleanup to 15 additional documentation files, completing the comprehensive documentation standardization initiative. **Batch 5 - Validation Reports & Architecture (6 files):** - aap-architecture-validation-report.md - aap-deployment-validation-crc.md - dr-architecture-validation-report.md - openshift-aap-architecture.md - rhel-aap-architecture.md - component-testing-results.md **Batch 6 - Implementation, Reference & Navigation (9 files):** - dr-replication-implementation-status.md - dr-scenarios.md - dr-testing-implementation-summary.md - enterprisefailovermanager.md - scripts-hooks-and-cicd.md - scripts-library-reference.md - cicd-pipeline.md - documentation-audit-report.md - INDEX.md (central documentation navigation hub) **Phase 2 - Terminology Standardization:** - Additional PostgreSQL terminology fixes across validation reports - Standardized datacenter/DC1/DC2 references - Consistent AAP expansion in reference documentation **Phase 3 - Code Block Language Tags:** - Added text tags to test outputs and validation results - Tagged configuration examples with ini/properties - Improved syntax highlighting for all code examples **INDEX.md Special Improvements:** - Removed excessive bold formatting for better readability - Standardized terminology throughout navigation - Enhanced cross-reference formatting - Improved table readability and scannability **Cumulative Progress:** - 31 of 33 documentation files cleaned (94%) - 200+ terminology standardizations - 80+ code blocks properly tagged - 1 file excluded as requested Standards compliance: CONTRIBUTING.md, CLAUDE.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * feat: Add Copilot skills for AAP 2.6 and Ansible best practices - Create .copilot/skills/aap-openshift-2-6 with SKILL.md and reference.md - Create .copilot/skills/ansible-redhat-cop-practices with SKILL.md and reference.md - Mirror Cursor skills structure for Copilot CLI compatibility Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Description
Systematic documentation cleanup implementing Phase 2 & 3 of the comprehensive documentation improvement plan. This PR standardizes terminology across 16 documentation files and adds proper syntax highlighting to improve readability and professional presentation.
Changes Made
Phase 2 - Terminology Standardization:
Phase 3 - Code Block Language Tags:
Files Modified (16):
Quality Improvements:
Statistics:
Testing
Validation performed:
Related Work
This PR is part of a comprehensive documentation cleanup initiative:
Impact
Positive:
No Breaking Changes:
Checklist
Generated with Claude Code