keep icon indicating copy to clipboard operation
keep copied to clipboard

[📃 Docs]: incorrect capitalization of “PagerDuty” in documentation

Open gecube opened this issue 4 months ago • 0 comments

Summary

On the Service Topology overview page
👉 https://docs.keephq.dev/overview/servicetopology,
the product name PagerDuty is written incorrectly as “Pagerduty” (with a lowercase d).

Additionally, the same issue appears on the PagerDuty provider documentation page:
👉 https://docs.keephq.dev/providers/documentation/pagerduty-provider

There may also be other occurrences across the documentation or codebase where the capitalization is inconsistent.

The correct product name is PagerDuty — with a capital D.


🧩 Steps to reproduce

  1. Open https://docs.keephq.dev/overview/servicetopology
  2. Observe the mention of “Pagerduty” in the list of providers
  3. Optionally, open https://docs.keephq.dev/providers/documentation/pagerduty-provider
  4. Notice the same lowercase usage

💡 Expected behavior

All references to the product should use the correct capitalization:

PagerDuty

This applies to:

  • Documentation (titles, headings, body text)
  • Provider names in the UI (if applicable)
  • Any code identifiers or YAML examples that reference the integration

✅ Proposed fix

  1. Update all documentation pages and metadata files to use “PagerDuty” (capital D).
  2. Verify consistency across the docs site and provider definitions.
  3. Optionally, add a linter or spell-check rule to catch common capitalization mistakes for well-known product names.

🧠 Rationale

Consistent naming:

  • Improves documentation quality and professionalism
  • Preserves brand correctness for integrated products
  • Avoids confusion when searching for official integrations or support articles

Labels: type:bug area:documentation priority:low

gecube avatar Oct 24 '25 20:10 gecube