Skip to content

docs: Standardize terminology and add code block language tags#39

Merged
chadmf merged 1 commit into
mainfrom
docs-cleanup
Apr 9, 2026
Merged

docs: Standardize terminology and add code block language tags#39
chadmf merged 1 commit into
mainfrom
docs-cleanup

Conversation

@chadmf

@chadmf chadmf commented Apr 8, 2026

Copy link
Copy Markdown
Collaborator

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:

  • 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

Statistics:

  • 16 files modified
  • 264 lines changed (132 insertions, 132 deletions)
  • 100+ terminology standardizations
  • 40+ code blocks enhanced

Testing

  • Pre-commit hooks passed
  • All changes reviewed for accuracy and consistency
  • Documentation standards compliance verified (CONTRIBUTING.md)
  • Cross-references and links validated
  • Code block syntax verified for proper rendering
  • Terminology consistency checked across all modified files
  • Protected file excluded as requested (aap-containerized-enterprise-dr-architecture.md)
  • Backup created: docs-backup-20260406-181510.tar.gz

Validation performed:

  • Grep search confirmed 100+ "Postgres" → "PostgreSQL" replacements
  • Verified proper preservation of technical contexts (lowercase "postgres")
  • Confirmed code block language tags render correctly
  • Checked all 16 files for consistency
  • Verified no functional changes to technical content

Related Work

This PR is part of a comprehensive documentation cleanup initiative:

  • Follows standards defined in CONTRIBUTING.md and CLAUDE.md
  • Implements Phase 2 & 3 of documented cleanup plan
  • Future phases will address cross-references, formatting, and TOC improvements

Impact

Positive:

  • Improved professional presentation
  • Better accessibility (removed decorative emojis)
  • Enhanced syntax highlighting for code examples
  • Consistent terminology for better searchability
  • Aligned with industry standard branding (PostgreSQL)

No Breaking Changes:

  • All changes are cosmetic/presentational
  • No functional modifications to code, commands, or technical procedures
  • All technical references preserved accurately

Checklist

  • Documentation updated
  • Tests pass (pre-commit, validation)
  • No breaking changes
  • Follows conventional commit format
  • PR description complete
  • Changes align with CONTRIBUTING.md standards

Generated with Claude Code

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 chadmf merged commit 8b0e7af into main Apr 9, 2026
8 checks passed
chadmf added a commit that referenced this pull request Apr 9, 2026
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>
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant