Skip to content

Commit

Permalink
Fix broken links (#17902)
Browse files Browse the repository at this point in the history
* Fox broken links

* correct points' nums
  • Loading branch information
nataliasitko authored Jul 31, 2023
1 parent 6b6fdb6 commit 2636537
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/01-overview/serverless/svls-05-useful-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ If you're interested in learning more about the Serverless area, follow these li

- [Function](../../05-technical-reference/00-custom-resources/svls-01-function.md) custom resource
- [`config.yaml` file](../../05-technical-reference/svls-06-function-configuration-file.md) in Kyma CLI
- [Function specification details](../../05-technical-reference/svls-08-function-specification.md)
- [Function specification details](../../05-technical-reference/svls-07-function-specification.md)

- Understand technicalities behind Serverless implementation:

- [Serverless architecture](../../05-technical-reference/00-architecture/svls-01-architecture.md) and [Function processing](../../05-technical-reference/svls-02-function-processing-stages.md)
- [Switching registries](../../05-technical-reference/svls-03-switching-registries.md)
- [Git source type](../../05-technical-reference/svls-04-git-source-type.md)
- [Exposing Functions](../../05-technical-reference/svls-05-exposing-functions.md)
- [Available presets](../../05-technical-reference/svls-09-available-presets.md)
- [Available presets](../../05-technical-reference/svls-08-available-presets.md)
- [Environment variables in Functions](../../05-technical-reference/00-configuration-parameters/svls-02-environment-variables.md)
4 changes: 2 additions & 2 deletions docs/01-overview/serverless/svls-07-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There is no upper limit of Functions that can be run on Kyma (similar to Kuberne

## Build phase limitation:
The time necessary to build Function depends on:
- selected [build profile](../../05-technical-reference/svls-09-available-presets.md#build-jobs-resources) that determines the requested resources (and their limits) for the build phase
- selected [build profile](../../05-technical-reference/svls-08-available-presets.md#build-jobs-resources) that determines the requested resources (and their limits) for the build phase
- number and size of dependencies that must be downloaded and bundled into the Function image.
- cluster nodes specification (see the note with reference specification at the end of the article)

Expand Down Expand Up @@ -54,7 +54,7 @@ This limitation is configurable using [`containers.manager.envs.functionBuildMax


## Runtime phase limitations
In the runtime, the Functions serve user-provided logic wrapped in the WEB framework (`express` for Node.js and `bottle` for Python). Taking the user logic aside, those frameworks have limitations and depend on the selected [runtime profile](../../05-technical-reference/svls-09-available-presets.md#functions-resources) and the Kubernetes nodes specification (see the note with reference specification at the end of this article).
In the runtime, the Functions serve user-provided logic wrapped in the WEB framework (`express` for Node.js and `bottle` for Python). Taking the user logic aside, those frameworks have limitations and depend on the selected [runtime profile](../../05-technical-reference/svls-08-available-presets.md#functions-resources) and the Kubernetes nodes specification (see the note with reference specification at the end of this article).

The following describes the response times of the selected runtime profiles for a "hello world" Function requested at 50 requests/second. This describes the overhead of the serving framework itself. Any user logic added on top of that will add extra milliseconds and must be profiled separately.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ You created the `lastorder` Function, and subscribed to the `order.received.v1`
http://localhost:3000/myapp/v1/events
```
> **NOTE:** If you want to use a Function to publish a CloudEvent, see the [Event object SDK specification](../../05-technical-reference/svls-08-function-specification.md#event-object-sdk).
> **NOTE:** If you want to use a Function to publish a CloudEvent, see the [Event object SDK specification](../../05-technical-reference/svls-07-function-specification.md#event-object-sdk).
## Verify the legacy event delivery
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This tutorial shows how you can create a simple "Hello World" Function in Node.j

>**TIP:** Serverless also allows you to store the Function's code and dependencies as sources in a Git repository. To learn more, read how to [Create a Git Function](./svls-02-create-git-function.md).
>**TIP:** Read about [Function’s specification](../../05-technical-reference/svls-08-function-specification.md) if you are interested in its signature, `event` and `context` objects, and custom HTTP responses the Function returns.
>**TIP:** Read about [Function’s specification](../../05-technical-reference/svls-07-function-specification.md) if you are interested in its signature, `event` and `context` objects, and custom HTTP responses the Function returns.
>**NOTE:** Read about [Istio sidecars in Kyma and why you want them](../../01-overview/service-mesh/smsh-03-istio-sidecars-in-kyma.md). Then, check how to [enable automatic Istio sidecar proxy injection](../../04-operation-guides/operations/smsh-01-istio-enable-sidecar-injection.md). For more details, see [Default Istio setup in Kyma](../../01-overview/service-mesh/smsh-02-default-istio-setup-in-kyma.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/03-tutorials/00-serverless/svls-03-expose-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When you complete this tutorial, you get a Function that:

>**NOTE:** To learn more about securing your Function, see the [Expose and secure a workload with OAuth2](../00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-01-expose-and-secure-workload-oauth2.md) or [Expose and secure a workload with JWT](../00-api-exposure/apix-05-expose-and-secure-a-workload/apix-05-03-expose-and-secure-workload-jwt.md) tutorials.
>**TIP:** Read also about [Function’s specification](../../05-technical-reference/svls-08-function-specification.md) if you are interested in its signature, `event` and `context` objects, and custom HTTP responses the Function returns.
>**TIP:** Read also about [Function’s specification](../../05-technical-reference/svls-07-function-specification.md) if you are interested in its signature, `event` and `context` objects, and custom HTTP responses the Function returns.
## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ This tutorial shows only one possible use case. There are many more use cases on
```
>**NOTE:** The `sap.kyma.custom.acme.payload.sanitised.v1` is a sample event type declared by the emitter Function when publishing events. You can choose a different one that better suits your use case. Keep in mind the constraints described on the [Event names](../../05-technical-reference/evnt-01-event-names.md) page. The receiver subscribes to the event type to consume the events.

>**NOTE:** The event object provides convenience functions to build and publish events. To send the event, build the Cloud Event. To learn more, read [Function's specification](../../05-technical-reference/svls-08-function-specification.md#event-object-sdk). In addition, your **eventOut.source** key must point to `“kyma”` to use Kyma in-cluster Eventing.
>**NOTE:** The event object provides convenience functions to build and publish events. To send the event, build the Cloud Event. To learn more, read [Function's specification](../../05-technical-reference/svls-07-function-specification.md#event-object-sdk). In addition, your **eventOut.source** key must point to `“kyma”` to use Kyma in-cluster Eventing.
>**NOTE:** There is a `require('axios')` line even though the Function code is not using it directly. This is needed for the auto-instrumentation to properly handle the outgoing requests sent using the `publishCloudEvent` method (which uses `axios` library under the hood). Without the `axios` import the Function still works, but the published events are not reflected in the trace backend.
4. Apply your emitter Function:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Customize Function traces
This tutorial shows how to use the build-in OpenTelemetry tracer object to send custom trace data to the trace backend.

Kyma Functions are instrumented to handle trace headers. This means that every time you call your Function, the executed logic is traceable using a dedicated span visible in the trace backend (i.e. start time and duration).
Additionally, you can extend the default trace context and create your own custom spans whenever you feel it is helpful (i.e. when calling a remote service in your distributed application) or add additional information to the tracing context by introducing events and tags. This tutorial shows you how to do it using tracer client that is available as part of the [event](../../05-technical-reference/svls-08-function-specification.md#event-object) object.
Additionally, you can extend the default trace context and create your own custom spans whenever you feel it is helpful (i.e. when calling a remote service in your distributed application) or add additional information to the tracing context by introducing events and tags. This tutorial shows you how to do it using tracer client that is available as part of the [event](../../05-technical-reference/svls-07-function-specification.md#event-object) object.

## Prerequisites

Expand Down

0 comments on commit 2636537

Please sign in to comment.