Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

switch link checking to GH action #268

Merged
merged 4 commits into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
14 changes: 14 additions & 0 deletions .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Markdown Links Check
run-name: ${{github.event.pull_request.title}}
on: [ pull_request ]
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-verbose-mode: 'no'
config-file: '.mlc.config.json'
folder-path: '.'
max-depth: -1
3 changes: 0 additions & 3 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,3 @@

# All .md files
*.md @mmitoraj @NHingerl @grego952 @IwonaLanger @nataliasitko

# Config file for MILV - milv.config.yaml
milv.config.yaml @m00g3n @pPrecel
2 changes: 1 addition & 1 deletion custom-serverless-runtime-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ This example shows how to create own custom runtime for a serverless Function ba
docker push "${IMAGE_NAME}/${IMAGE_TAG}"
```

> **Note:** You can use it to define your Functions in Kyma. To learn more, read [how to override runtime image](https://kyma-project.io/docs/kyma/main/05-technical-reference/svls-08-function-specification#override-runtime-image).
> **Note:** You can use it to define your Functions in Kyma. To learn more, read [how to override runtime image](https://kyma-project.io/#/serverless-manager/user/resources/06-20-serverless-cr?id=custom-resource-parameters).
8 changes: 4 additions & 4 deletions jaeger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

The following instructions outline how to use [`Jaeger`](https://github.com/jaegertracing/helm-charts/tree/main/charts/jaeger) as a tracing backend with Kyma's [TracePipeline](https://kyma-project.io/docs/kyma/main/01-overview/telemetry/telemetry-03-traces/).
The following instructions outline how to use [`Jaeger`](https://github.com/jaegertracing/helm-charts/tree/main/charts/jaeger) as a tracing backend with Kyma's [TracePipeline](https://kyma-project.io/#/telemetry-manager/user/03-traces).

## Prerequisites

Expand Down Expand Up @@ -52,7 +52,7 @@ kubectl -n $KYMA_NS rollout status deploy $HELM_JAEGER_RELEASE

### Activate a TracePipeline

To configure the Kyma trace collector with the deployed Jaeger instance as the backend. To create a new [TracePipeline](https://kyma-project.io/docs/kyma/main/01-overview/telemetry/telemetry-03-traces/),
To configure the Kyma trace collector with the deployed Jaeger instance as the backend. To create a new [TracePipeline](https://kyma-project.io/#/telemetry-manager/user/03-traces),
execute the following command:
```bash
cat <<EOF | kubectl -n $KYMA_NS apply -f -
Expand All @@ -71,7 +71,7 @@ execute the following command:

### Activate Istio Tracing

To [enable Istio](https://kyma-project.io/docs/kyma/main/01-overview/telemetry/telemetry-03-traces#step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
To [enable Istio](https://kyma-project.io/#/telemetry-manager/user/03-traces?id=step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.

```bash
cat <<EOF | kubectl apply -f -
Expand All @@ -95,7 +95,7 @@ To access Jaeger using port forwarding, run:
kubectl -n $KYMA_NS port-forward svc/$HELM_JAEGER_RELEASE-query 16686
```

Open the Jaeger UI in your browser under [http://localhost:16686](http://localhost:16686).
Open the Jaeger UI in your browser under `http://localhost:16686`.

### Deploy a workload and activate Kyma's TracePipeline feature

Expand Down
2 changes: 1 addition & 1 deletion kiali/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To access Kiali, either use kubectl port forwarding, or expose it using the Kyma
kubectl -n $KYMA_NS port-forward svc/kiali-server 20001
```

Open Kiali in your browser under [http://localhost:20001](http://localhost:20001) and log in with a [Kubernetes service account token](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens), for instance, from your kubeconfig file.
Open Kiali in your browser under `http://localhost:20001` and log in with a [Kubernetes service account token](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#service-account-tokens), for instance, from your kubeconfig file.

* To expose Kiali using the Kyma API Gateway, create an APIRule:
```bash
Expand Down
2 changes: 1 addition & 1 deletion loki/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing a custom Loki stack in Kyma

## Overview
The following instructions outline how to use [`Loki`](https://github.com/grafana/loki/tree/main/production/helm/loki) as a logging backend with Kyma's [LogPipeline](https://kyma-project.io/docs/kyma/main/01-overview/telemetry/telemetry-02-logs/) or with [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/).
The following instructions outline how to use [`Loki`](https://github.com/grafana/loki/tree/main/production/helm/loki) as a logging backend with Kyma's [LogPipeline](https://kyma-project.io/#/telemetry-manager/user/02-logs) or with [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/).

>**CAUTION:** This example uses the Grafana Loki version, which is distributed under AGPL-3.0 only and might not be free of charge for commercial usage.

Expand Down
16 changes: 0 additions & 16 deletions milv.config.yaml

This file was deleted.

4 changes: 2 additions & 2 deletions prometheus/monitoring-custom-metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ This example shows how to expose custom metrics to Prometheus with a Golang serv
kubectl -n ${KYMA_NS} port-forward $(kubectl -n ${KYMA_NS} get service -l app=kube-prometheus-stack-prometheus -oname) 9090
```

All the **sample-metrics** endpoints appear as the [`Targets`](http://localhost:9090/targets#job-sample-metrics) list.
All the **sample-metrics** endpoints appear as `Targets` under `http://localhost:9090/targets#job-sample-metrics` list.

2. Use either `cpu_temperature_celsius` or `hd_errors_total` in the **expression** field [here](http://localhost:9090/graph).
2. Use either `cpu_temperature_celsius` or `hd_errors_total` in the **expression** field under `http://localhost:9090/graph`.
3. Click the **Execute** button to check the values scraped by Prometheus.

### Cleanup
Expand Down
2 changes: 1 addition & 1 deletion trace-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The following instructions install the OpenTelemetry [demo application](https://
1. Provide a tracing backend and activate it.
Install [Jaeger in-cluster](./../jaeger/) or provide a custom backend supporting the OTLP protocol.
2. Activate the Istio tracing feature.
To [enable Istio](https://kyma-project.io/docs/kyma/main/01-overview/telemetry/telemetry-03-traces#step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
To [enable Istio](https://kyma-project.io/#/telemetry-manager/user/03-traces?id=step-2-enable-istio-tracing) to report span data, apply an Istio telemetry resource and set the sampling rate to 100%. This approach is not recommended for production.
```bash
cat <<EOF | kubectl apply -f -
apiVersion: telemetry.istio.io/v1alpha1
Expand Down