Skip to content

Commit ff76bdd

Browse files
heitorlessaheitorlessa
committed
fix(docs): address all warnings for internal links
1 parent ef10c4a commit ff76bdd

File tree

7 files changed

+25
-25
lines changed

7 files changed

+25
-25
lines changed

‎docs/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -705,18 +705,18 @@ Core utilities such as Tracing, Logging, Metrics, and Event Handler will be avai
705705
| Environment variable | Description | Utility | Default |
706706
| ----------------------------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | --------------------- |
707707
| **POWERTOOLS_SERVICE_NAME** | Sets service name used for tracing namespace, metrics dimension and structured logging | All | `"service_undefined"` |
708-
| **POWERTOOLS_METRICS_NAMESPACE** | Sets namespace used for metrics | [Metrics](./core/metrics){target="_blank"} | `None` |
709-
| **POWERTOOLS_TRACE_DISABLED** | Explicitly disables tracing | [Tracing](./core/tracer){target="_blank"} | `false` |
710-
| **POWERTOOLS_TRACER_CAPTURE_RESPONSE** | Captures Lambda or method return as metadata. | [Tracing](./core/tracer){target="_blank"} | `true` |
711-
| **POWERTOOLS_TRACER_CAPTURE_ERROR** | Captures Lambda or method exception as metadata. | [Tracing](./core/tracer){target="_blank"} | `true` |
712-
| **POWERTOOLS_TRACE_MIDDLEWARES** | Creates sub-segment for each custom middleware | [Middleware factory](./utilities/middleware_factory){target="_blank"} | `false` |
713-
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming event | [Logging](./core/logger){target="_blank"} | `false` |
714-
| **POWERTOOLS_LOGGER_SAMPLE_RATE** | Debug log sampling | [Logging](./core/logger){target="_blank"} | `0` |
715-
| **POWERTOOLS_LOG_DEDUPLICATION_DISABLED** | Disables log deduplication filter protection to use Pytest Live Log feature | [Logging](./core/logger){target="_blank"} | `false` |
716-
| **POWERTOOLS_PARAMETERS_MAX_AGE** | Adjust how long values are kept in cache (in seconds) | [Parameters](./utilities/parameters/#adjusting-cache-ttl){target="_blank"} | `5` |
717-
| **POWERTOOLS_PARAMETERS_SSM_DECRYPT** | Sets whether to decrypt or not values retrieved from AWS SSM Parameters Store | [Parameters](./utilities/parameters/#ssmprovider){target="_blank"} | `false` |
708+
| **POWERTOOLS_METRICS_NAMESPACE** | Sets namespace used for metrics | [Metrics](./core/metrics.md){target="_blank"} | `None` |
709+
| **POWERTOOLS_TRACE_DISABLED** | Explicitly disables tracing | [Tracing](./core/tracer.md){target="_blank"} | `false` |
710+
| **POWERTOOLS_TRACER_CAPTURE_RESPONSE** | Captures Lambda or method return as metadata. | [Tracing](./core/tracer.md){target="_blank"} | `true` |
711+
| **POWERTOOLS_TRACER_CAPTURE_ERROR** | Captures Lambda or method exception as metadata. | [Tracing](./core/tracer.md){target="_blank"} | `true` |
712+
| **POWERTOOLS_TRACE_MIDDLEWARES** | Creates sub-segment for each custom middleware | [Middleware factory](./utilities/middleware_factory.md){target="_blank"} | `false` |
713+
| **POWERTOOLS_LOGGER_LOG_EVENT** | Logs incoming event | [Logging](./core/logger.md){target="_blank"} | `false` |
714+
| **POWERTOOLS_LOGGER_SAMPLE_RATE** | Debug log sampling | [Logging](./core/logger.md){target="_blank"} | `0` |
715+
| **POWERTOOLS_LOG_DEDUPLICATION_DISABLED** | Disables log deduplication filter protection to use Pytest Live Log feature | [Logging](./core/logger.md){target="_blank"} | `false` |
716+
| **POWERTOOLS_PARAMETERS_MAX_AGE** | Adjust how long values are kept in cache (in seconds) | [Parameters](./utilities/parameters.md#adjusting-cache-ttl){target="_blank"} | `5` |
717+
| **POWERTOOLS_PARAMETERS_SSM_DECRYPT** | Sets whether to decrypt or not values retrieved from AWS SSM Parameters Store | [Parameters](./utilities/parameters.md#ssmprovider){target="_blank"} | `false` |
718718
| **POWERTOOLS_DEV** | Increases verbosity across utilities | Multiple; see [POWERTOOLS_DEV effect below](#optimizing-for-non-production-environments) | `false` |
719-
| **LOG_LEVEL** | Sets logging level | [Logging](./core/logger){target="_blank"} | `INFO` |
719+
| **LOG_LEVEL** | Sets logging level | [Logging](./core/logger.md){target="_blank"} | `INFO` |
720720

721721
### Optimizing for non-production environments
722722

‎docs/maintainers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ These are some questions to keep in mind when drafting your first or future rele
251251

252252
- Can customers understand at a high level what changed in this release?
253253
- Is there a link to the documentation where they can read more about each main change?
254-
- Are there any graphics or [code snippets](carbon.now.sh/) that can enhance readability?
254+
- Are there any graphics or [code snippets](https://carbon.now.sh/) that can enhance readability?
255255
- Are we calling out any key contributor(s) to this release?
256256
- All contributors are automatically credited, use this as an exceptional case to feature them
257257

‎docs/tutorial/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ For this to work, we could create a new Lambda function to handle incoming reque
226226
We could group similar routes and intents, separate read and write operations resulting in fewer functions. It doesn't address the boilerplate routing code, but maybe it will be easier to add additional URLs.
227227

228228
???+ info "Info: You might be already asking yourself about mono vs micro-functions"
229-
If you want a more detailed explanation of these two approaches, head over to the [trade-offs on each approach](../core/event_handler/api_gateway/#considerations){target="_blank"} later.
229+
If you want a more detailed explanation of these two approaches, head over to the [trade-offs on each approach](../core/event_handler/api_gateway.md#considerations){target="_blank"} later.
230230

231231
A first attempt at the routing logic might look similar to the following code snippet.
232232

@@ -773,7 +773,7 @@ Another subtle difference is that you can now run your Lambda functions and unit
773773
Powertools for AWS Lambda (Python) optimizes for Lambda compute environment. As such, we add these and other common approaches to accelerate your development, so you don't worry about implementing every cross-cutting concern.
774774

775775
???+ tip
776-
You can [opt-out some of these behaviours](../core/tracer/#advanced){target="_blank"} like disabling response capturing, explicitly patching only X modules, etc.
776+
You can [opt-out some of these behaviours](../core/tracer.md#advanced){target="_blank"} like disabling response capturing, explicitly patching only X modules, etc.
777777

778778
Repeat the process of building, deploying, and invoking your application via the API endpoint. Within the [AWS X-Ray Console](https://console.aws.amazon.com/xray/home#/traces/){target="_blank"}, you should see a similar view:
779779

‎docs/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ You can migrate to `BatchProcessor` with the following changes:
4444

4545
1. If you use **`sqs_batch_decorator`**, change to **`batch_processor`** decorator
4646
2. If you use **`PartialSQSProcessor`**, change to **`BatchProcessor`**
47-
3. [Enable **`ReportBatchItemFailures`** in your Lambda Event Source](../utilities/batch#required-resources){target="_blank"}
47+
3. [Enable **`ReportBatchItemFailures`** in your Lambda Event Source](./utilities/batch.md#required-resources){target="_blank"}
4848
4. Change your Lambda Handler to return the new response format
4949

5050
=== "[Before] Decorator"

‎docs/utilities/idempotency.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -496,14 +496,14 @@ When using DynamoDB as a persistence layer, you can alter the attribute names by
496496

497497
Idempotent decorator can be further configured with **`IdempotencyConfig`** as seen in the previous example. These are the available options for further configuration
498498

499-
| Parameter | Default | Description |
500-
| ------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
501-
| **event_key_jmespath** | `""` | JMESPath expression to extract the idempotency key from the event record using [built-in functions](/utilities/jmespath_functions){target="_blank"} |
502-
| **payload_validation_jmespath** | `""` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
503-
| **raise_on_no_idempotency_key** | `False` | Raise exception if no idempotency key was found in the request |
504-
| **expires_after_seconds** | 3600 | The number of seconds to wait before a record is expired |
505-
| **use_local_cache** | `False` | Whether to locally cache idempotency results |
506-
| **local_cache_max_items** | 256 | Max number of items to store in local cache |
499+
| Parameter | Default | Description |
500+
| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
501+
| **event_key_jmespath** | `""` | JMESPath expression to extract the idempotency key from the event record using [built-in functions](./jmespath_functions.md#built-in-jmespath-functions){target="_blank"} |
502+
| **payload_validation_jmespath** | `""` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
503+
| **raise_on_no_idempotency_key** | `False` | Raise exception if no idempotency key was found in the request |
504+
| **expires_after_seconds** | 3600 | The number of seconds to wait before a record is expired |
505+
| **use_local_cache** | `False` | Whether to locally cache idempotency results |
506+
| **local_cache_max_items** | 256 | Max number of items to store in local cache |
507507
| **hash_function** | `md5` | Function to use for calculating hashes, as provided by [hashlib](https://docs.python.org/3/library/hashlib.html){target="_blank" rel="nofollow"} in the standard library. |
508508

509509
### Handling concurrent executions with the same payload

‎docs/utilities/middleware_factory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ If you are making use of [Tracer](../core/tracer.md){target="_blank"}, you can t
9292
This makes use of an existing Tracer instance that you may have initialized anywhere in your code.
9393

9494
???+ warning
95-
You must [enable Active Tracing](../core/tracer/#permissions){target="_blank"} in your Lambda function when using this feature, otherwise Lambda cannot send traces to XRay.
95+
You must [enable Active Tracing](../core/tracer.md#permissions){target="_blank"} in your Lambda function when using this feature, otherwise Lambda cannot send traces to XRay.
9696

9797
=== "getting_started_middleware_tracer_function.py"
9898
```python hl_lines="8 14 15 36"

‎docs/we_made_this.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ This article walks through how CyberArk uses Powertools to implement Feature Fla
8282

8383
### Designing for Idempotency
8484

85-
> **Author: [Valentin Dreismann](linkedin.com/in/valentin-dreismann-69694b16a){target="_blank" rel="nofollow"}** :material-linkedin:
85+
> **Author: [Valentin Dreismann](https://linkedin.com/in/valentin-dreismann-69694b16a){target="_blank" rel="nofollow"}** :material-linkedin:
8686
8787
This article outlines the importance of idempotency, key considerations and trade-offs when implementing in your systems.
8888

0 commit comments

Comments
 (0)