chore: update some docs (#433)

Some minor doc updates to reword or remove things that don't make sense in the context of the public library. --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_
cdklabs · Sep 27, 2023 · 064d54f · 064d54f
1 parent dadff59
commit 064d54f
Show file tree

Hide file tree

Showing 8 changed files with 124 additions and 180 deletions.
diff --git a/API.md b/API.md
diff --git a/lib/common/alarm/AlarmFactory.ts b/lib/common/alarm/AlarmFactory.ts
@@ -77,15 +77,15 @@ export interface AddAlarmProps {
 
   /**
    * If this is defined, the alarm dedupe string is set to this exact value.
-   * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually.
+   * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.
    *
    * @default - undefined (no override)
    */
   readonly dedupeStringOverride?: string;
 
   /**
    * If this is defined, the alarm name is set to this exact value.
-   * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually.
+   * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.
    */
   readonly alarmNameOverride?: string;
 
@@ -436,7 +436,7 @@ export interface AlarmFactoryDefaults {
   readonly evaluationPeriods?: number;
 
   /**
-   * Global prefix for all alarm names. This should be something unique to avoid collisions with other CTIs.
+   * Global prefix for all alarm names. This should be something unique to avoid potential collisions.
    * This is ignored if an alarm's dedupeStringOverride is declared.
    */
   readonly alarmNamePrefix: string;

diff --git a/lib/common/alarm/CustomAlarmThreshold.ts b/lib/common/alarm/CustomAlarmThreshold.ts
@@ -20,16 +20,15 @@ export interface CustomAlarmThreshold {
 
   /**
    * If this is defined, the alarm dedupe string is set to this exact value.
-   * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and realms (EU, NA...) manually.
-   * Dedupe strings are global and not unique per CTI.
+   * Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually.
    *
    * @default - undefined (no override)
    */
   readonly dedupeStringOverride?: string;
 
   /**
    * If this is defined, the alarm name is set to this exact value.
-   * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and realms (EU, NA...) manually.
+   * Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually.
    */
   readonly alarmNameOverride?: string;
 

diff --git a/lib/dashboard/widget/BitmapWidget.ts b/lib/dashboard/widget/BitmapWidget.ts
@@ -31,7 +31,7 @@ export class BitmapWidgetRenderingSupport extends Construct {
         )
       ),
       description:
-        "Custom Widget Render for Bitmap Widgets (MonitoringCDKConstructs)",
+        "Custom Widget Render for Bitmap Widgets (cdk-monitoring-constructs)",
       handler: "index.handler",
       memorySize: 128,
       runtime: Runtime.NODEJS_18_X,

diff --git a/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts b/lib/monitoring/aws-secretsmanager/SecretsManagerMetricsPublisher.ts
@@ -31,7 +31,7 @@ export class SecretsManagerMetricsPublisher extends Construct {
         )
       ),
       description:
-        "Custom metrics publisher for SecretsManager Secrets (MonitoringCDKConstructs)",
+        "Custom metrics publisher for SecretsManager Secrets (cdk-monitoring-constructs)",
       handler: "index.handler",
       memorySize: 128,
       runtime: Runtime.NODEJS_18_X,

diff --git a/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap b/test/dashboard/widget/__snapshots__/BitmapWidget.test.ts.snap
diff --git a/test/facade/__snapshots__/MonitoringAspect.test.ts.snap b/test/facade/__snapshots__/MonitoringAspect.test.ts.snap
diff --git a/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap b/test/monitoring/aws-secretsmanager/__snapshots__/SecretsManagerSecretMonitoring.test.ts.snap