diff --git a/aws_lambda_powertools/metrics/base.py b/aws_lambda_powertools/metrics/base.py index 1d5c0e48570..ee7553148b1 100644 --- a/aws_lambda_powertools/metrics/base.py +++ b/aws_lambda_powertools/metrics/base.py @@ -549,11 +549,6 @@ class SingleMetric(MetricManager): metric.add_dimension(name="function_version", value=47) print(json.dumps(metric.serialize_metric_set(), indent=4)) - - Parameters - ---------- - MetricManager : MetricManager - Inherits from `aws_lambda_powertools.metrics.base.MetricManager` """ def add_metric( diff --git a/docs/api_doc/metrics/metrics.md b/docs/api_doc/metrics/metrics.md deleted file mode 100644 index ec268279335..00000000000 --- a/docs/api_doc/metrics/metrics.md +++ /dev/null @@ -1,2 +0,0 @@ - -::: aws_lambda_powertools.metrics.metrics diff --git a/docs/build_recipes/getting-started.md b/docs/build_recipes/getting-started.md index 71a891a9163..95288f274f3 100644 --- a/docs/build_recipes/getting-started.md +++ b/docs/build_recipes/getting-started.md @@ -21,7 +21,7 @@ Each build tool has its strengths and is optimized for different use cases. Cons | --------------------- | --------------------------------- | ------------------------------------------- | | **[pip](build-tools.md#pip)** | Simple projects, CI/CD | Lightweight, universal | | **[uv](build-tools.md#uv)** | Fast builds, performance-critical | Extremely fast, Rust-based | -| **[poetry](bbuild-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files | +| **[poetry](build-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files | | **[SAM](build-tools.md#sam)** | AWS-native deployments | Integrated with AWS, local testing | | **[CDK](build-tools.md#cdk)** | Infrastructure as code | Programmatic infrastructure, type safety | | **[pants](build-tools.md#pants)** | Monorepos, complex projects | Advanced build system, incremental builds | diff --git a/docs/build_recipes/index.md b/docs/build_recipes/index.md index bc1b506b54a..ea7e53838af 100644 --- a/docs/build_recipes/index.md +++ b/docs/build_recipes/index.md @@ -39,7 +39,7 @@ This guide is organized into focused sections to help you find exactly what you ### 📚 Fundamentals * **[Getting started](getting-started.md)** - Prerequisites, tool selection, and basic setup -* **[Cross-platform builds](cross-integration.md)** - Handle architecture differences and compiled dependencies +* **[Cross-platform builds](cross-platform.md)** - Handle architecture differences and compiled dependencies ### 🔧 Build tools diff --git a/docs/contributing/getting_started.md b/docs/contributing/getting_started.md index 3cdcc6b1ddc..3ee11c93c32 100644 --- a/docs/contributing/getting_started.md +++ b/docs/contributing/getting_started.md @@ -17,7 +17,7 @@ graph LR ## Types of contributions -We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](../../LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct). +We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](https://github.com/aws-powertools/powertools-lambda-python/blob/develop/LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct). Whether you're new contributor or a pro, we compiled a list of the common contributions to help you choose your first: diff --git a/docs/core/event_handler/api_gateway.md b/docs/core/event_handler/api_gateway.md index 3dc09f61131..af0600a9f22 100644 --- a/docs/core/event_handler/api_gateway.md +++ b/docs/core/event_handler/api_gateway.md @@ -1013,7 +1013,7 @@ These are native middlewares that may become native features depending on custom | Middleware | Purpose | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [SchemaValidationMiddleware](/lambda/python/latest/api/event_handler/middlewares/schema_validation.html){target="_blank"} | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} | +| SchemaValidationMiddleware | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} | #### Being a good citizen diff --git a/docs/core/event_handler/bedrock_agents.md b/docs/core/event_handler/bedrock_agents.md index 0e6adcd9767..1f2ca9e38b2 100644 --- a/docs/core/event_handler/bedrock_agents.md +++ b/docs/core/event_handler/bedrock_agents.md @@ -173,7 +173,7 @@ You'll need to regenerate the OpenAPI schema and update your Agent everytime you ``` 1. This ensures that it's only executed when running the file directly, and not when running on the Lambda runtime. - 2. You can use [additional options](#customizing-openapi-metadata) to customize the OpenAPI schema. + 2. You can use [additional options](#customizing-api-operations) to customize the OpenAPI schema. === "OpenAPI schema" diff --git a/docs/core/metrics.md b/docs/core/metrics.md index aa52e9b98e8..7d3dd46509d 100644 --- a/docs/core/metrics.md +++ b/docs/core/metrics.md @@ -395,7 +395,7 @@ Current providers: | Provider | Notes | | ------------------------------------- | -------------------------------------------------------- | -| [Datadog](./datadog){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default | +| [Datadog](./datadog.md){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default | ## Testing your code diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md index a66edad20de..c561dea8953 100644 --- a/docs/tutorial/index.md +++ b/docs/tutorial/index.md @@ -487,8 +487,8 @@ Let's break this down: * **L5**: We add Powertools for AWS Lambda (Python) Logger; the boilerplate is now done for you. By default, we set `INFO` as the logging level if `POWERTOOLS_LOG_LEVEL` env var isn't set. * **L22**: We use `logger.inject_lambda_context` decorator to inject key information from Lambda context into every log. -* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md##set_correlation_id-method){target="_blank"} automatically. -* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](./index.md#environment-variables){target="_blank"}. +* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md#setting-a-correlation-id){target="_blank"} automatically. +* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](../index.md#environment-variables){target="_blank"}. This is how the logs would look like now: diff --git a/docs/upgrade.md b/docs/upgrade.md index 0e57d8fb609..25de20fec23 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -13,7 +13,7 @@ Given our commitment to all of our customers using Powertools for AWS Lambda (Py ## Migrate to v3 from v2 -!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](/lambda/python/2.43.1/upgrade/)." +!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](https://docs.powertools.aws.dev/lambda/python/2.43.1/)." We've made minimal breaking changes to make your transition to v3 as smooth as possible. diff --git a/docs/utilities/data_masking.md b/docs/utilities/data_masking.md index 5abcc185938..2f7ea247155 100644 --- a/docs/utilities/data_masking.md +++ b/docs/utilities/data_masking.md @@ -105,7 +105,7 @@ Erasing will remove the original data and replace it with a `*****`. This means --8<-- "examples/data_masking/src/getting_started_erase_data.py" ``` - 1. See [working with nested data](#working-with-nested-data) to learn more about the `fields` parameter.

If we omit `fields` parameter, the entire dictionary will be erased with `*****`. + 1. See [choosing parts of your data](#choosing-parts-of-your-data) to learn more about the `fields` parameter.

If we omit `fields` parameter, the entire dictionary will be erased with `*****`. === "generic_data_input.json" ```json hl_lines="7 9 14" diff --git a/docs/utilities/idempotency.md b/docs/utilities/idempotency.md index 7786813b9e4..afda814459f 100644 --- a/docs/utilities/idempotency.md +++ b/docs/utilities/idempotency.md @@ -54,7 +54,7 @@ classDiagram ## Getting started -We use Amazon DynamoDB as the default persistence layer in the documentation. If you prefer Redis, you can learn more from [this section](#redis-database). +We use Amazon DynamoDB as the default persistence layer in the documentation. If you prefer Redis, you can learn more from [this section](#cache-database). ### IAM Permissions @@ -69,7 +69,7 @@ When using Amazon DynamoDB as the persistence layer, you will need the following **First time setting it up?** -We provide Infrastrucure as Code examples with [AWS Serverless Application Model (SAM)](#aws-serverless-application-model-sam-example), [AWS Cloud Development Kit (CDK)](#aws-cloud-development-kit-cdk), and [Terraform](#terraform) with the required permissions. +We provide Infrastrucure as Code examples with [AWS Serverless Application Model (SAM)](#dynamodb-iac-examples), [AWS Cloud Development Kit (CDK)](#aws-cloud-development-kit-cdk), and [Terraform](#terraform) with the required permissions. ### Required resources diff --git a/mkdocs.yml b/mkdocs.yml index da9216248c6..9f6e0749fbe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,6 @@ nav: - Changelog: changelog.md - Tutorial: tutorial/index.md - Workshop 🆕: https://s12d.com/powertools-for-aws-lambda-workshop" target="_blank - - API reference: api/" target="_blank - Features: - core/tracer.md - core/logger.md