Skip to content

Commit 1b6318c

Browse files
committed
chore: add AWS bootstrap js
1 parent 0453ecd commit 1b6318c

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

docs/features/kafka.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Kafka Consumer
33
description: Utility
4-
status: new
54
---
65

76
The Kafka Consumer utility transparently handles message deserialization, provides an intuitive developer experience, and integrates seamlessly with the rest of the Powertools for AWS Lambda ecosystem.
@@ -38,7 +37,7 @@ The Kafka Consumer utility transparently handles message deserialization, provid
3837
Lambda processes Kafka messages as discrete events rather than continuous streams, requiring a different approach to consumer development that Powertools for AWS helps standardize.
3938

4039
| Aspect | Traditional Kafka Consumers | Lambda Kafka Consumer |
41-
|-----------------------|-------------------------------------|----------------------------------------------------------------|
40+
| --------------------- | ----------------------------------- | -------------------------------------------------------------- |
4241
| **Model** | Pull-based (you poll for messages) | Push-based (Lambda invoked with messages) |
4342
| **Scaling** | Manual scaling configuration | Automatic scaling to partition count |
4443
| **State** | Long-running application with state | Stateless, ephemeral executions |
@@ -201,15 +200,15 @@ The Kafka consumer utility supports multiple serialization formats to match your
201200
=== "Supported Formats"
202201

203202
| Format | Schema Type | Description | Required Parameters |
204-
|----------------------|--------------|-----------------------------------|--------------------------------------|
203+
| -------------------- | ------------ | --------------------------------- | ------------------------------------ |
205204
| **JSON** | `"JSON"` | Human-readable text format | None |
206205
| **Avro** | `"AVRO"` | Compact binary format with schema | `value.schema` (Avro schema string) |
207206
| **Protocol Buffers** | `"PROTOBUF"` | Efficient binary format | `value.schema` (Proto message class) |
208207

209208
=== "Format Comparison"
210209

211210
| Feature | JSON | Avro | Protocol Buffers |
212-
|-------------------------------|----------|----------------------|-------------------------|
211+
| ----------------------------- | -------- | -------------------- | ----------------------- |
213212
| **Schema Definition** | Optional | Required JSON schema | Required Protobuf class |
214213
| **Schema Evolution** | None | Strong support | Strong support |
215214
| **Size Efficiency** | Low | High | Highest |
@@ -241,7 +240,7 @@ For debugging purposes, you can also access the original key, value, and headers
241240
#### Available metadata properties
242241

243242
| Property | Description | Example Use Case |
244-
|-----------------------|------------------------------------------------------------------|---------------------------------------------------------------------|
243+
| --------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------- |
245244
| `topic` | Topic name the record was published to | Routing logic in multi-topic consumers |
246245
| `partition` | Kafka partition number | Tracking message distribution |
247246
| `offset` | Position in the partition | De-duplication, exactly-once processing |
@@ -304,7 +303,7 @@ Handle errors gracefully when processing Kafka messages to ensure your applicati
304303
#### Error types
305304

306305
| Exception | Description | Common Causes |
307-
|--------------------------------------|-----------------------------------------------|-----------------------------------------------------------------------------|
306+
| ------------------------------------ | --------------------------------------------- | --------------------------------------------------------------------------- |
308307
| `KafkaConsumerError`. | Base class for all Kafka consumer errors | General unhandled errors |
309308
| `KafkaConsumerDeserializationError` | Thrown when message deserialization fails | Corrupted message data, schema mismatch, or wrong schema type configuration |
310309
| `KafkaConsumerMissingSchemaError` | Thrown when a required schema is not provided | Missing schema for AVRO or PROTOBUF formats (required parameter) |

docs/overrides/main.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,9 @@
55
<a href="{{ '../' ~ base_url }}">
66
<strong>Click here to go to latest.</strong>
77
</a>
8+
{% endblock %}
9+
10+
{% block extrahead %}
11+
<meta name="guide-name" content="Powertools for AWS Lambda (TypeScript)">
12+
<meta name="service-name" content="Powertools for AWS Lambda">
813
{% endblock %}

mkdocs.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ site_description: Powertools for AWS Lambda (TypeScript)
33
site_author: Amazon Web Services
44
repo_url: https://github.com/aws-powertools/powertools-lambda-typescript
55
edit_uri: edit/main/docs
6-
site_url: https://docs.powertools.aws.dev/lambda/typescript/latest
6+
site_url: https://docs.aws.amazon.com/powertools/typescript/latest/
77
watch: [
88
docs,
99
packages/batch/src,
@@ -179,7 +179,6 @@ plugins:
179179
- getting-started/typescript-settings.md
180180
- getting-started/lambda-layers.md
181181
Features:
182-
- features/index.md
183182
- features/tracer.md
184183
- features/logger.md
185184
- features/metrics.md
@@ -202,9 +201,8 @@ plugins:
202201
extra_css:
203202
- stylesheets/extra.css
204203
extra_javascript:
205-
- javascript/aws-amplify.min.js
206-
- javascript/extra.js
207-
- https://docs.powertools.aws.dev/shared/mermaid.min.js
204+
- https://docs.aws.amazon.com/powertools/shared/mermaid.min.js
205+
- https://docs.aws.amazon.com/assets/js/awsdocs-boot.js
208206

209207
extra:
210208
version:

0 commit comments

Comments
 (0)