Skip to content

docs: Correct link targets and line highlights #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 9, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/core/event_handler/appsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This is the sample infrastructure we are using for the initial examples with a A
=== "schema.graphql"

!!! tip "Designing GraphQL Schemas for the first time?"
Visit [AWS AppSync schema documentation](https://docs.aws.amazon.com/appsync/latest/devguide/designing-your-schema.html) for understanding how to define types, nesting, and pagination.
Visit [AWS AppSync schema documentation](https://docs.aws.amazon.com/appsync/latest/devguide/designing-your-schema.html){target="_blank"} for understanding how to define types, nesting, and pagination.

```typescript
--8<-- "docs/shared/getting_started_schema.graphql"
Expand Down Expand Up @@ -183,7 +183,7 @@ Here's an example where we have two separate functions to resolve `getTodo` and

=== "app.py"

```python hl_lines="3-4 8 30-31 38-39 46"
```python hl_lines="3-5 9 31-32 39-40 47"
from aws_lambda_powertools import Logger, Tracer

from aws_lambda_powertools.logging import correlation_paths
Expand Down Expand Up @@ -428,7 +428,7 @@ Assuming you have [Amplify CLI installed](https://docs.amplify.aws/cli/start/ins

=== "schema.graphql"

```typescript hl_lines="8 10 18 23 25"
```typescript hl_lines="7 15 20 22"
@model
type Merchant {
id: String!
Expand Down
8 changes: 4 additions & 4 deletions docs/utilities/middleware_factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ You can also have your own keyword arguments after the mandatory arguments.

## Tracing middleware execution

If you are making use of [Tracer](../core/tracer.md), you can trace the execution of your middleware to ease operations.
If you are making use of [Tracer](/core/tracer), you can trace the execution of your middleware to ease operations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert these. I've just tested and MKdocs correctly builds internal links as they should.

image


This makes use of an existing Tracer instance that you may have initialized anywhere in your code.

Expand All @@ -78,9 +78,9 @@ This makes use of an existing Tracer instance that you may have initialized anyw
...
```

When executed, your middleware name will [appear in AWS X-Ray Trace details as](../core/tracer) `## middleware_name`.
When executed, your middleware name will [appear in AWS X-Ray Trace details as](/core/tracer) `## middleware_name`.

For advanced use cases, you can instantiate [Tracer](../core/tracer) inside your middleware, and add annotations as well as metadata for additional operational insights.
For advanced use cases, you can instantiate [Tracer](/core/tracer) inside your middleware, and add annotations as well as metadata for additional operational insights.

=== "app.py"

Expand All @@ -100,7 +100,7 @@ For advanced use cases, you can instantiate [Tracer](../core/tracer) inside your

* Use `trace_execution` to quickly understand the performance impact of your middlewares, and reduce or merge tasks when necessary
* When nesting multiple middlewares, always return the handler with event and context, or response
* Keep in mind [Python decorators execution order](https://realpython.com/primer-on-python-decorators/#nesting-decorators). Lambda handler is actually called once (top-down)
* Keep in mind [Python decorators execution order](https://realpython.com/primer-on-python-decorators/#nesting-decorators){target="_blank"}. Lambda handler is actually called once (top-down)
* Async middlewares are not supported

## Testing your code
Expand Down
6 changes: 3 additions & 3 deletions docs/utilities/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can validate inbound and outbound events using [`validator` decorator](#vali

You can also use the standalone `validate` function, if you want more control over the validation process such as handling a validation error.

We support any JSONSchema draft supported by [fastjsonschema](https://horejsek.github.io/python-fastjsonschema/) library.
We support any JSONSchema draft supported by [fastjsonschema](https://horejsek.github.io/python-fastjsonschema/){target="_blank"} library.

!!! warning
Both `validator` decorator and `validate` standalone function expects your JSON Schema to be a **dictionary**, not a filename.
Expand Down Expand Up @@ -184,7 +184,7 @@ Envelope name | JMESPath expression
### Validating custom formats

!!! note "New in 1.10.0"
JSON Schema DRAFT 7 [has many new built-in formats](https://json-schema.org/understanding-json-schema/reference/string.html#format) such as date, time, and specifically a regex format which might be a better replacement for a custom format, if you do have control over the schema.
JSON Schema DRAFT 7 [has many new built-in formats](https://json-schema.org/understanding-json-schema/reference/string.html#format){target="_blank"} such as date, time, and specifically a regex format which might be a better replacement for a custom format, if you do have control over the schema.

JSON Schemas with custom formats like `int64` will fail validation. If you have these, you can pass them using `formats` parameter:

Expand Down Expand Up @@ -528,7 +528,7 @@ This sample will decompress and decode base64 data, then use JMESPath pipeline e

This will **replace all provided built-in functions such as `powertools_json`, so you will no longer be able to use them**.

For special binary formats that you want to decode before applying JSON Schema validation, you can bring your own [JMESPath function](https://github.com/jmespath/jmespath.py#custom-functions) and any additional option via `jmespath_options` param.
For special binary formats that you want to decode before applying JSON Schema validation, you can bring your own [JMESPath function](https://github.com/jmespath/jmespath.py#custom-functions){target="_blank"} and any additional option via `jmespath_options` param.

=== "custom_jmespath_function.py"

Expand Down