chore(docs): review docs highlighted code snippets (#1469)

dreamorosi · web-flow · commit 90a524031e37 · 2023-05-19T14:20:13.000+02:00
diff --git a/docs/core/logger.md b/docs/core/logger.md
@@ -68,7 +68,7 @@ These settings will be used across all logs emitted:
       ShoppingCartApiFunction:
         Type: AWS::Serverless::Function
         Properties:
-          Runtime: nodejs16.x
+          Runtime: nodejs18.x
           Environment:
             Variables:
               LOG_LEVEL: WARN
@@ -112,7 +112,7 @@ This functionality will include the following keys in your structured logs:
         You can install Middy by running `npm i @middy/core`.
         Learn more about [its usage and lifecycle in the official Middy documentation](https://middy.js.org/docs/intro/getting-started){target="_blank"}.
 
-    ```typescript hl_lines="1-2 13"
+    ```typescript hl_lines="1 13"
     --8<-- "docs/snippets/logger/middy.ts"
     ```
 
@@ -402,7 +402,7 @@ The `createChild` method allows you to create a child instance of the Logger, wh
 
 === "Example CloudWatch Logs excerpt"
 
-    ```json hl_lines="15-21"
+    ```json hl_lines="21"
     {
         "level": "INFO",
         "message": "This is an INFO log, from the parent logger",
@@ -590,31 +590,31 @@ This is how the printed log would look:
 === "Example CloudWatch Logs excerpt"
 
     ```json
-        {
-            "message": "This is an INFO log",
-            "service": "serverlessAirline",
-            "awsRegion": "eu-west-1",
-            "correlationIds": {
-                "awsRequestId": "c6af9ac6-7b61-11e6-9a41-93e812345678",
-                "xRayTraceId": "abcdef123456abcdef123456abcdef123456",
-                "myCustomCorrelationId": "foo-bar-baz"
-            },
-            "lambdaFunction": {
-                "name": "shopping-cart-api-lambda-prod-eu-west-1",
-                "arn": "arn:aws:lambda:eu-west-1:123456789012:function:shopping-cart-api-lambda-prod-eu-west-1",
-                "memoryLimitInMB": 128,
-                "version": "$LATEST",
-                "coldStart": true
-            },
-            "logLevel": "INFO",
-            "timestamp": "2021-12-12T23:13:53.404Z",
-            "logger": {
-                "sampleRateValue": "0.5",
-                "name": "aws-lambda-powertools-typescript",
-                "version": "0.0.1"
-            },
-            "awsAccountId": "123456789012"
-        }
+    {
+        "message": "This is an INFO log",
+        "service": "serverlessAirline",
+        "awsRegion": "eu-west-1",
+        "correlationIds": {
+            "awsRequestId": "c6af9ac6-7b61-11e6-9a41-93e812345678",
+            "xRayTraceId": "abcdef123456abcdef123456abcdef123456",
+            "myCustomCorrelationId": "foo-bar-baz"
+        },
+        "lambdaFunction": {
+            "name": "shopping-cart-api-lambda-prod-eu-west-1",
+            "arn": "arn:aws:lambda:eu-west-1:123456789012:function:shopping-cart-api-lambda-prod-eu-west-1",
+            "memoryLimitInMB": 128,
+            "version": "$LATEST",
+            "coldStart": true
+        },
+        "logLevel": "INFO",
+        "timestamp": "2021-12-12T23:13:53.404Z",
+        "logger": {
+            "sampleRateValue": "0.5",
+            "name": "aws-lambda-powertools-typescript",
+            "version": "0.0.1"
+        },
+        "awsAccountId": "123456789012"
+    }
     ```
 
 !!! tip "Custom Log formatter and Child loggers"
diff --git a/docs/core/metrics.md b/docs/core/metrics.md
@@ -251,25 +251,21 @@ See below an example of how to automatically flush metrics with the Middy-compat
 
 === "Example CloudWatch Logs excerpt"
 
-    ```json hl_lines="2 7 10 15 22"
+    ```json
     {
         "successfulBooking": 1.0,
         "_aws": {
-        "Timestamp": 1592234975665,
-        "CloudWatchMetrics": [
-            {
-            "Namespace": "serverlessAirline",
-            "Dimensions": [
-                [
-                "service"
-                ]
-            ],
-            "Metrics": [
-                {
-                "Name": "successfulBooking",
-                "Unit": "Count"
-                }
-            ]
+            "Timestamp": 1592234975665,
+            "CloudWatchMetrics": [{
+                "Namespace": "serverlessAirline",
+                "Dimensions": [
+                    [ "service" ]
+                ],
+                "Metrics": [{
+                    "Name": "successfulBooking",
+                    "Unit": "Count"
+                }]
+            }]
         },
         "service": "orders"
     }
@@ -293,25 +289,21 @@ The `logMetrics` decorator of the metrics utility can be used when your Lambda h
 
 === "Example CloudWatch Logs excerpt"
 
-    ```json hl_lines="2 7 10 15 22"
+    ```json
     {
         "successfulBooking": 1.0,
         "_aws": {
-        "Timestamp": 1592234975665,
-        "CloudWatchMetrics": [
-            {
-            "Namespace": "successfulBooking",
-            "Dimensions": [
-                [
-                "service"
-                ]
-            ],
-            "Metrics": [
-                {
-                "Name": "successfulBooking",
-                "Unit": "Count"
-                }
-            ]
+            "Timestamp": 1592234975665,
+            "CloudWatchMetrics": [{
+                "Namespace": "successfulBooking",
+                "Dimensions": [
+                    [ "service" ]
+                ],
+                "Metrics": [{
+                    "Name": "successfulBooking",
+                    "Unit": "Count"
+                }]
+            }]
         },
         "service": "orders"
     }
@@ -332,27 +324,21 @@ You can manually flush the metrics with `publishStoredMetrics` as follows:
 
 === "Example CloudWatch Logs excerpt"
 
-    ```json hl_lines="2 7 10 15 22"
+    ```json
     {
         "successfulBooking": 1.0,
         "_aws": {
-        "Timestamp": 1592234975665,
-        "CloudWatchMetrics": [
-            {
-            "Namespace": "successfulBooking",
-            "Dimensions": [
-                [
-                "service"
-                ]
-            ],
-            "Metrics": [
-                {
-                "Name": "successfulBooking",
-                "Unit": "Count"
-                }
-            ]
-            }
-        ]
+            "Timestamp": 1592234975665,
+            "CloudWatchMetrics": [{
+                "Namespace": "successfulBooking",
+                "Dimensions": [
+                    [ "service" ]
+                ],
+                "Metrics": [{
+                    "Name": "successfulBooking",
+                    "Unit": "Count"
+                }]
+            }]
         },
         "service": "orders"
     }
@@ -410,35 +396,27 @@ You can add high-cardinality data as part of your Metrics log with the `addMetad
 
 === "Example CloudWatch Logs excerpt"
 
-    ```json hl_lines="23"
+    ```json hl_lines="31"
     {
         "successfulBooking": 1.0,
         "_aws": {
-        "Timestamp": 1592234975665,
-        "CloudWatchMetrics": [
-            {
-            "Namespace": "serverlessAirline",
-            "Dimensions": [
-                [
-                "service"
-                ]
-            ],
-            "Metrics": [
-                {
-                "Namespace": "exampleApplication",
+            "Timestamp": 1592234975665,
+            "CloudWatchMetrics": [{
+                "Namespace": "serverlessAirline",
                 "Dimensions": [
-                    [
-                    "service"
-                    ]
+                    [ "service" ]
                 ],
-                "Metrics": [
-                    {
-                    "Name": "successfulBooking",
-                    "Unit": "Count"
-                    }
-                ]
-                }
-            ]
+                "Metrics": [{
+                    "Namespace": "exampleApplication",
+                    "Dimensions": [
+                        [ "service" ]
+                    ],
+                    "Metrics": [{
+                        "Name": "successfulBooking",
+                        "Unit": "Count"
+                    }]
+                }]
+            }]
         },
         "service": "orders",
         "bookingId": "7051cd10-6283-11ec-90d6-0242ac120003"
diff --git a/docs/core/tracer.md b/docs/core/tracer.md
@@ -72,7 +72,7 @@ The `Tracer` utility is instantiated outside of the Lambda handler. In doing thi
       HelloWorldFunction:
         Type: AWS::Serverless::Function
         Properties:
-          Runtime: nodejs16.x
+          Runtime: nodejs18.x
           Tracing: Active
           Environment:
             Variables:
@@ -89,7 +89,7 @@ You can quickly start by importing the `Tracer` class, initialize it outside the
         You can install Middy by running `npm i @middy/core`.
         Learn more about [its usage and lifecycle in the official Middy documentation](https://middy.js.org/docs/intro/getting-started){target="_blank"}.
 
-    ```typescript hl_lines="1-2 14 16"
+    ```typescript hl_lines="1 14 16"
     --8<-- "docs/snippets/tracer/middy.ts"
     ```
 
diff --git a/docs/index.md b/docs/index.md
@@ -31,13 +31,13 @@ You can install Powertools using one of the following options:
 
 ### Lambda Layer
 
-???+ warning "As of now, Container Image deployment (OCI) or inline Lambda functions do not support Lambda Layers."
+??? warning "As of now, Container Image deployment (OCI) or inline Lambda functions do not support Lambda Layers"
 
 [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html){target="_blank"} is a .zip file archive that can contain additional code, pre-packaged dependencies, data,  or configuration files. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic.
 
 You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework.
 
-??? note "Note: Click to expand and copy any regional Lambda Layer ARN"
+??? note "Click to expand and copy any regional Lambda Layer ARN"
 
     | Region           | Layer ARN                                                                                                    |
     | ---------------- | ------------------------------------------------------------------------------------------------------------ |
@@ -67,7 +67,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
     | `af-south-1`     | [arn:aws:lambda:af-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:11](#){: .copyMe}:clipboard:     |
     | `me-south-1`     | [arn:aws:lambda:me-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:11](#){: .copyMe}:clipboard:     |
 
-??? note "Note: Click to expand and copy code snippets for popular frameworks"
+??? note "Click to expand and copy code snippets for popular frameworks"
     
     === "SAM"
 
@@ -81,7 +81,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
 
         If you use `esbuild` to bundle your code, make sure to exclude `@aws-lambda-powertools` from being bundled since the packages will be already present the Layer:
 
-        ```yaml hl_lines="5"
+        ```yaml hl_lines="5-14"
         MyLambdaFunction:
           Type: AWS::Serverless::Function
           Properties:
@@ -173,7 +173,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
 
     === "Terraform"
 
-        ```terraform hl_lines="9 36"
+        ```terraform hl_lines="18"
         terraform {
           required_version = "~> 1.0.5"
           required_providers {
@@ -224,7 +224,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
 
     === "Amplify"
 
-        ```zsh
+        ```zsh hl_lines="9 19"
         # Create a new one with the layer
         ❯ amplify add function
         ? Select which capability you want to add: Lambda function (serverless function)
@@ -247,7 +247,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
         ? Do you want to edit the local lambda function now? No
         ```
 
-!!! info "Using Powertools via Lambda Layer? Simply add the Powertools utilities you are using as a development dependency."
+!!! info "Using Powertools via Lambda Layer? Simply add the Powertools utilities you are using as a development dependency"
 
 ??? question "Want to inspect the contents of the Layer?"
 	Change {region} to your AWS region, e.g. `eu-west-1`
