From 0845948cb336b1d30a606c0afd2208eaadec0c7e Mon Sep 17 00:00:00 2001 From: Andreas Thaler Date: Tue, 12 Sep 2023 09:18:54 +0200 Subject: [PATCH] switch link checking to GH action (#268) * removed governance config * fix * adds GH for link checking * fix broken links --- .github/workflows/markdown-link-check.yml | 14 ++++++++++++++ CODEOWNERS | 3 --- custom-serverless-runtime-image/README.md | 2 +- jaeger/README.md | 8 ++++---- kiali/README.md | 2 +- loki/README.md | 2 +- milv.config.yaml | 16 ---------------- prometheus/monitoring-custom-metrics/README.md | 4 ++-- trace-demo/README.md | 2 +- 9 files changed, 24 insertions(+), 29 deletions(-) create mode 100644 .github/workflows/markdown-link-check.yml delete mode 100644 milv.config.yaml diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml new file mode 100644 index 00000000..f3e87216 --- /dev/null +++ b/.github/workflows/markdown-link-check.yml @@ -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 diff --git a/CODEOWNERS b/CODEOWNERS index 0965de47..b2430d07 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -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 diff --git a/custom-serverless-runtime-image/README.md b/custom-serverless-runtime-image/README.md index 710e7d1f..2cf76889 100644 --- a/custom-serverless-runtime-image/README.md +++ b/custom-serverless-runtime-image/README.md @@ -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). diff --git a/jaeger/README.md b/jaeger/README.md index 8c08388f..1b17a9d2 100644 --- a/jaeger/README.md +++ b/jaeger/README.md @@ -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 @@ -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 <**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. diff --git a/milv.config.yaml b/milv.config.yaml deleted file mode 100644 index f2f0cd22..00000000 --- a/milv.config.yaml +++ /dev/null @@ -1,16 +0,0 @@ -external-links-to-ignore: ["localhost", "kyma.local", "kyma-system"] -files-to-ignore: ["/vendor/"] -timeout: 60 -request-repeats: 5 -files: - - path: "./examples/.github/ISSUE_TEMPLATE/security-vulnerability.md" - config: - internal-links-to-ignore: ["{CVSS"] - external-links-to-ignore: ["https://www.first.org/cvss/calculator/3.0#CVSS:3.0/AV:N/AC:L/PR:L/UI:N/S:U/C:H/I:L/A:N"] - - path: "./examples/tracing/README.md" - config: - external-links-to-ignore: ["https://jaeger.{YOUR_CLUSTER_DOMAIN"] - - path: "./examples/trace-demo/README.md" - config: - external-links-to-ignore: ["https://frontend.$CLUSTER_DOMAIN"] - \ No newline at end of file diff --git a/prometheus/monitoring-custom-metrics/README.md b/prometheus/monitoring-custom-metrics/README.md index d8726333..6c4d3f64 100644 --- a/prometheus/monitoring-custom-metrics/README.md +++ b/prometheus/monitoring-custom-metrics/README.md @@ -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 diff --git a/trace-demo/README.md b/trace-demo/README.md index 3a09e150..12a05cf0 100644 --- a/trace-demo/README.md +++ b/trace-demo/README.md @@ -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 <