From 5f6102c958aa0ca0b45e2370253742e8ec0561a3 Mon Sep 17 00:00:00 2001 From: Grzegorz Karaluch Date: Wed, 15 Nov 2023 06:57:08 +0100 Subject: [PATCH] Fix links found by Link Checker (#415) Co-authored-by: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com> --- CODE_OF_CONDUCT.md | 2 +- README.md | 3 ++- components/serverless/design/glossary_proposal.md | 2 +- config/serverless/charts/webhook/README.md | 2 +- .../technical-reference/07-20-function-processing-stages.md | 6 +++--- .../technical-reference/07-70-function-specification.md | 2 +- docs/user/tutorials/01-50-sync-function-with-gitops.md | 4 ++-- docs/user/tutorials/_sidebar.md | 2 +- 8 files changed, 12 insertions(+), 11 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4de0804d7..b86285c79 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ # Code of conduct -Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations. +Each contributor and maintainer of this project agrees to follow the [community Code of Conduct](https://github.com/kyma-project/community/blob/main/docs/contributing/01-code-of-conduct.md) that relies on the CNCF Code of Conduct. Read it to learn about the agreed standards of behavior, shared values that govern our community, and details on how to report any suspected Code of Conduct violations. diff --git a/README.md b/README.md index a54f4db00..8c2bf536a 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/lat - Use external registry. - The following example shows how you can modify the Serverless docker registry address using the `serverless.operator.kyma-project.io` CR: + The following example shows how you can modify the Serverless Docker registry address using the `serverless.operator.kyma-project.io` CR: ```bash kubectl create secret generic my-secret \ @@ -112,6 +112,7 @@ kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/lat ``` > **NOTE:** For DockerHub: + > - SERVER_ADDRESS is "https://index.docker.io/v1/", > - USERNAME and REGISTRY_ADDRESS must be identical. diff --git a/components/serverless/design/glossary_proposal.md b/components/serverless/design/glossary_proposal.md index a6410f0d8..e1a1971ba 100644 --- a/components/serverless/design/glossary_proposal.md +++ b/components/serverless/design/glossary_proposal.md @@ -4,7 +4,7 @@ Currently, Serverless in Kyma consists of two projects: -- [function-controller](https://github.com/kyma-project/kyma/tree/main/components/function-controller) - +- [function-controller](../README.md)() - responsible for running a Function on a Kubernetes cluster - [serverless-manager](https://github.com/kyma-project/serverless-manager) - responsible for installation and configuration of Serverless diff --git a/config/serverless/charts/webhook/README.md b/config/serverless/charts/webhook/README.md index bdf5cc8de..3d30a3f4b 100644 --- a/config/serverless/charts/webhook/README.md +++ b/config/serverless/charts/webhook/README.md @@ -6,4 +6,4 @@ This project contains the chart for the Webhook. ## Details -For more information, read the Webhooks [README](https://github.com/kyma-project/kyma/tree/main/components/function-controller/README.md) file. +For more information, read the Webhooks [README](../../../../components/serverless/README.md) file. diff --git a/docs/user/technical-reference/07-20-function-processing-stages.md b/docs/user/technical-reference/07-20-function-processing-stages.md index 31e9850d0..f856d5115 100644 --- a/docs/user/technical-reference/07-20-function-processing-stages.md +++ b/docs/user/technical-reference/07-20-function-processing-stages.md @@ -1,6 +1,6 @@ # Function processing stages -From the moment you [create a Function](01-10-create-inline-function.md) (Function CR) until the time it is ready, it goes through three processing stages that are defined as these condition types: +From the moment you [create a Function](../tutorials/01-10-create-inline-function.md) (Function CR) until the time it is ready, it goes through three processing stages that are defined as these condition types: 1. `ConfigurationReady` (PrinterColumn `CONFIGURED`) 2. `BuildReady` (PrinterColumn `BUILT`) @@ -17,13 +17,13 @@ When you update an existing Function, conditions change asynchronously depending The diagrams illustrate all three core status changes in the Function processing circle that the Function Controller handles. They also list all custom resources involved in this process and specify in which cases their update is required. ->**NOTE:** Before you start reading, see the [Function CR](resources/06-10-function-cr.md) document for the custom resource detailed definition, the list of all Function's condition types, and reasons for their success or failure. +>**NOTE:** Before you start reading, see the [Function CR](../resources/06-10-function-cr.md) document for the custom resource detailed definition, the list of all Function's condition types, and reasons for their success or failure. ## Configured This initial phase starts when you create a Function CR with configuration specifying the Function's setup. It ends with creating a ConfigMap that is used as a building block for a Function image. -![Function configured](../assets/svls-configured.svg) +![Function configured](../../assets/svls-configured.svg) ## Built diff --git a/docs/user/technical-reference/07-70-function-specification.md b/docs/user/technical-reference/07-70-function-specification.md index 2fbba5a0f..db4cc5365 100644 --- a/docs/user/technical-reference/07-70-function-specification.md +++ b/docs/user/technical-reference/07-70-function-specification.md @@ -257,6 +257,6 @@ You can use a custom runtime image to override the existing one. Your image must - Fetch sources from the path under the `KUBELESS_INSTALL_VOLUME` environment - Security support. Kyma runtimes are secure by default. You only need to protect your images. -> **NOTE:** For better understanding, you can look at the [main Docker files](https://github.com/kyma-project/kyma/blob/main/resources/serverless/templates/runtimes.yaml). They are responsible for building the final image based on the `base_image` argument. You, as a user, can override it and what we are doing in [this tutorial](../tutorials/01-110-override-runtime-image.md). +> **NOTE:** For better understanding, you can look at the [main Docker files](../../../config/serverless/templates/runtimes.yaml). They are responsible for building the final image based on the `base_image` argument. You, as a user, can override it and what we are doing in [this tutorial](../tutorials/01-110-override-runtime-image.md). Every Function's Pods container has the same system environments, which helps you configure the Functions server. For more information, read the [Environment variables](05-20-env-variables.md) page. \ No newline at end of file diff --git a/docs/user/tutorials/01-50-sync-function-with-gitops.md b/docs/user/tutorials/01-50-sync-function-with-gitops.md index 7896d5b41..074c2e4c2 100644 --- a/docs/user/tutorials/01-50-sync-function-with-gitops.md +++ b/docs/user/tutorials/01-50-sync-function-with-gitops.md @@ -38,10 +38,10 @@ These sections will lead you through the whole installation, configuration, and kubectl cluster-info ``` -3. Apply the `functions.serverless.kyma-project.io` CRD from sources in the [`kyma`](https://github.com/kyma-project/kyma/tree/main/installation/resources/crds/serverless) repository. You will need it to create the Function CR on the cluster. +3. Apply the `functions.serverless.kyma-project.io` CRD from sources in the [`serverless`](https://github.com/kyma-project/serverless/tree/main/components/serverless/config/crd) repository. You will need it to create the Function CR on the cluster. ```bash - kubectl apply -f https://raw.githubusercontent.com/kyma-project/kyma/main/installation/resources/crds/serverless/functions.serverless.crd.yaml + kubectl apply -f https://raw.githubusercontent.com/kyma-project/serverless/main/components/serverless/config/crd/bases/serverless.kyma-project.io_functions.yaml ``` 4. Run this command to make sure the CRs are applied: diff --git a/docs/user/tutorials/_sidebar.md b/docs/user/tutorials/_sidebar.md index 701b1f4fb..4d1da747d 100644 --- a/docs/user/tutorials/_sidebar.md +++ b/docs/user/tutorials/_sidebar.md @@ -6,7 +6,7 @@ * [Manage Functions through Kyma CLI](01-30-manage-functions-with-kyma-cli.md) * [Debug a Function](01-40-debug-function.md) * [Log into a private package registry](01-80-log-into-private-packages-registry.md) - * [Set asynchronous communication between Functions](01-90-set-asynchronous-connection) + * [Set asynchronous communication between Functions](01-90-set-asynchronous-connection.md) * [Customize Function traces](01-100-customize-function-traces.md) * [Override runtime image](01-110-override-runtime-image.md) * [Inject environment variables](01-120-inject-envs.md)