Skip to content

Commit

Permalink
Fix link to examples in docs (#832)
Browse files Browse the repository at this point in the history
  • Loading branch information
halamix2 authored Mar 20, 2024
1 parent dacf470 commit b55f682
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/user/08-10-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ Deploy everything in a consistent way either using CI/CD or GitOps operators (fo
> Kyma Functions come in two types: `git` and `inline`. For the [Git type](tutorials/01-11-create-git-function.md), you configure a Git repository as a source of your Function code instead of creating it `inline`.
Thus, you can skip rendering the Kubernetes manifests and deploying them each time you made a change in the Function code or dependencies. Simply push the changes to the referenced Git repository, and the Serverless controller will rebuild the Function deployed in your Kyma runtime.

Have a look at this [example](https://github.com/kyma-project/examples/tree/main/incluster_eventing) that illustrates how you can set up your Git project. Mind the `k8s resources` folder with the YAML manifests to be pushed to the Kubernetes API server (for example, using kubectl in our CI/CD or GitOps) and the `src` folder containing the Functions' source code. They are pulled directly by Kyma Serverless to build new Function images whenever the source content changes in the Git repository.
Have a look at this [example](https://github.com/kyma-project/serverless/tree/main/examples/incluster_eventing) that illustrates how you can set up your Git project. Mind the `k8s resources` folder with the YAML manifests to be pushed to the Kubernetes API server (for example, using kubectl in our CI/CD or GitOps) and the `src` folder containing the Functions' source code. They are pulled directly by Kyma Serverless to build new Function images whenever the source content changes in the Git repository.

Browse the [tutorials](tutorials/README.md) for Serverless to learn how to use it step-by-step in different scenarios.
Browse the [tutorials](tutorials/README.md) for Serverless to learn how to use it step-by-step in different scenarios.
4 changes: 2 additions & 2 deletions docs/user/tutorials/01-11-create-git-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ You can create a Function either with kubectl or Kyma dashboard:
> To avoid performance degradation caused by large Git repositories and large monorepos, [Function Controller](../resources/06-10-function-cr.md#related-resources-and-components) implements a configurable backoff period for the source checkout based on `APP_FUNCTION_REQUEUE_DURATION`. If you want to allow the controller to perform the source checkout with every reconciliation loop, disable the backoff period by marking the Function CR with the annotation `serverless.kyma-project.io/continuousGitCheckout: true`
> [!NOTE]
> See this [Function's code and dependencies](https://github.com/kyma-project/examples/tree/main/orders-service/function).
> See this [Function's code and dependencies](https://github.com/kyma-project/examples/tree/main/orders-service).

4. Check if your Function was created and all conditions are set to `True`:

Expand All @@ -143,4 +143,4 @@ You can create a Function either with kubectl or Kyma dashboard:
test-function True True True nodejs18 1 96s
```

<!-- tabs:end -->
<!-- tabs:end -->
2 changes: 1 addition & 1 deletion docs/user/tutorials/01-110-override-runtime-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before you start, make sure you have these tools installed:

Follow these steps:

1. Follow [this example](https://github.com/kyma-project/examples/tree/main/custom-serverless-runtime-image) to build the Python's custom runtime image.
1. Follow [this example](https://github.com/kyma-project/serverless/tree/main/examples/custom-serverless-runtime-image) to build the Python's custom runtime image.

<!-- tabs:start -->

Expand Down
4 changes: 2 additions & 2 deletions docs/user/tutorials/01-90-set-asynchronous-connection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Set Asynchronous Communication Between Functions

This tutorial demonstrates how to connect two Functions asynchronously. It is based on the [in-cluster Eventing example](https://github.com/kyma-project/examples/tree/main/incluster_eventing).
This tutorial demonstrates how to connect two Functions asynchronously. It is based on the [in-cluster Eventing example](https://github.com/kyma-project/serverless/tree/main/examples/incluster_eventing).

The example provides a very simple scenario of asynchronous communication between two Functions. The first Function accepts the incoming traffic via HTTP, sanitizes the payload, and publishes the content as an in-cluster event using [Kyma Eventing](https://kyma-project.io/docs/kyma/latest/01-overview/eventing/).
The second Function is a message receiver. It subscribes to the given event type and stores the payload.
Expand Down Expand Up @@ -139,4 +139,4 @@ This tutorial shows only one possible use case. There are many more use cases on

### Test the whole setup
Send a payload to the first Function. For example, use the POST request mentioned above. As the Functions are joined by the in-cluster Eventing, the payload is processed in sequence by both of your Functions.
In the Function's logs, you can see that both sanitization logic (using the first Function) and the storing logic (using the second Function) are executed.
In the Function's logs, you can see that both sanitization logic (using the first Function) and the storing logic (using the second Function) are executed.

0 comments on commit b55f682

Please sign in to comment.