From b1dd064934b9bf5654cac0b948dcc0ff6ad2b39b Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Mon, 5 Aug 2024 14:11:36 +0200 Subject: [PATCH] docs: fix some broken links (#3647) Signed-off-by: Moritz Wiesinger --- ...crd-docs-generator-config-lifecycle-v1alpha4.yaml | 3 --- .../generate-crd-docs/crd-docs-generator-config.yaml | 3 --- docs/docs/getting-started/lifecycle-management.md | 12 ++++++------ .../docs/reference/api-reference/metrics/v1/index.md | 8 ++++---- .../api-reference/metrics/v1alpha3/index.md | 8 ++++---- .../reference/api-reference/metrics/v1beta1/index.md | 8 ++++---- 6 files changed, 18 insertions(+), 24 deletions(-) diff --git a/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml b/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml index 2fd4465a40..9488598ef8 100644 --- a/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml +++ b/.github/scripts/generate-crd-docs/crd-docs-generator-config-lifecycle-v1alpha4.yaml @@ -30,6 +30,3 @@ render: - name: MapCarrier package: "go.opentelemetry.io/otel/propagation" link: https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier - - name: UID - package: "k8s.io/apimachinery/pkg/types" - link: https://pkg.go.dev/k8s.io/apimachinery@v0.29.2/pkg/types#UID diff --git a/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml b/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml index bf148f7391..9bc40d5208 100644 --- a/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml +++ b/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml @@ -24,6 +24,3 @@ render: - name: MapCarrier package: "go.opentelemetry.io/otel/propagation" link: https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier - - name: UID - package: "k8s.io/apimachinery/pkg/types" - link: https://pkg.go.dev/k8s.io/apimachinery@v0.29.2/pkg/types#UID diff --git a/docs/docs/getting-started/lifecycle-management.md b/docs/docs/getting-started/lifecycle-management.md index cd0ea2f9d4..5b21e3cfd9 100644 --- a/docs/docs/getting-started/lifecycle-management.md +++ b/docs/docs/getting-started/lifecycle-management.md @@ -50,7 +50,7 @@ For demo purposes, a place is required to which those requests are sent. To implement this: 1. Install the - [open source webhook.site tool](https://github.com/webhooksite/webhook.site/tree/master/kubernetes). + [open source webhook.site tool](https://github.com/webhooksite/webhook.site/tree/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes). This provides a place on your cluster to which web requests are sent and from which they can be viewed. @@ -59,11 +59,11 @@ To implement this: 1. Execute the following commands to apply the web hook: ```shell - kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/master/kubernetes/namespace.yml - kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/master/kubernetes/redis.deployment.yml - kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/master/kubernetes/laravel-echo-server.deployment.yml - kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/master/kubernetes/webhook.deployment.yml - kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/master/kubernetes/service.yml + kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes/namespace.yml + kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes/redis.deployment.yml + kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes/laravel-echo-server.deployment.yml + kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes/webhook.deployment.yml + kubectl apply -f https://raw.githubusercontent.com/webhooksite/webhook.site/7f10c9f4aecb243636c9e5197d4dbf8f5eaf5341/kubernetes/service.yml ``` 1. Wait until all Pods are running in the `webhook` namespace diff --git a/docs/docs/reference/api-reference/metrics/v1/index.md b/docs/docs/reference/api-reference/metrics/v1/index.md index aa2481fed2..498ebc7f70 100644 --- a/docs/docs/reference/api-reference/metrics/v1/index.md +++ b/docs/docs/reference/api-reference/metrics/v1/index.md @@ -133,7 +133,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | | `timeframe` _[Timeframe](#timeframe)_ | Timeframe specifies the range for the corresponding query in the AnalysisValueTemplate. Please note that either
a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can
not be added to the cluster. || x | | -| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:{{.foo}})". || ✓ | | +| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:\{\{.foo\}\})". || ✓ | | | `analysisDefinition` _[ObjectReference](#objectreference)_ | AnalysisDefinition refers to the AnalysisDefinition, a CRD that stores the AnalysisValuesTemplates || x | | @@ -452,7 +452,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `fixedValue` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | FixedValue defines the value for comparison || x | | +| `fixedValue` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | FixedValue defines the value for comparison || x | | #### ProviderRef @@ -523,8 +523,8 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `lowBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | LowBound defines the lower bound of the range || x | | -| `highBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | HighBound defines the higher bound of the range || x | | +| `lowBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | LowBound defines the lower bound of the range || x | | +| `highBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | HighBound defines the higher bound of the range || x | | #### Target diff --git a/docs/docs/reference/api-reference/metrics/v1alpha3/index.md b/docs/docs/reference/api-reference/metrics/v1alpha3/index.md index adbdd45cc4..58046f37ab 100644 --- a/docs/docs/reference/api-reference/metrics/v1alpha3/index.md +++ b/docs/docs/reference/api-reference/metrics/v1alpha3/index.md @@ -133,7 +133,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | | `timeframe` _[Timeframe](#timeframe)_ | Timeframe specifies the range for the corresponding query in the AnalysisValueTemplate. Please note that either
a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can
not be added to the cluster. || x | | -| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:{{.foo}})". || ✓ | | +| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:\{\{.foo\}\})". || ✓ | | | `analysisDefinition` _[ObjectReference](#objectreference)_ | AnalysisDefinition refers to the AnalysisDefinition, a CRD that stores the AnalysisValuesTemplates || x | | @@ -452,7 +452,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `fixedValue` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | FixedValue defines the value for comparison || x | | +| `fixedValue` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | FixedValue defines the value for comparison || x | | #### ProviderRef @@ -523,8 +523,8 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `lowBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | LowBound defines the lower bound of the range || x | | -| `highBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | HighBound defines the higher bound of the range || x | | +| `lowBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | LowBound defines the lower bound of the range || x | | +| `highBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | HighBound defines the higher bound of the range || x | | #### Target diff --git a/docs/docs/reference/api-reference/metrics/v1beta1/index.md b/docs/docs/reference/api-reference/metrics/v1beta1/index.md index 91637574a2..bc4c51aea9 100644 --- a/docs/docs/reference/api-reference/metrics/v1beta1/index.md +++ b/docs/docs/reference/api-reference/metrics/v1beta1/index.md @@ -133,7 +133,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | | `timeframe` _[Timeframe](#timeframe)_ | Timeframe specifies the range for the corresponding query in the AnalysisValueTemplate. Please note that either
a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can
not be added to the cluster. || x | | -| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:{{.foo}})". || ✓ | | +| `args` _object (keys:string, values:string)_ | Args corresponds to a map of key/value pairs that can be used to substitute placeholders in the AnalysisValueTemplate query. i.e. for args foo:bar the query could be "query:percentile(95)?scope=tag(my_foo_label:\{\{.foo\}\})". || ✓ | | | `analysisDefinition` _[ObjectReference](#objectreference)_ | AnalysisDefinition refers to the AnalysisDefinition, a CRD that stores the AnalysisValuesTemplates || x | | @@ -452,7 +452,7 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `fixedValue` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | FixedValue defines the value for comparison || x | | +| `fixedValue` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | FixedValue defines the value for comparison || x | | #### ProviderRef @@ -523,8 +523,8 @@ _Appears in:_ | Field | Description | Default | Optional |Validation | | --- | --- | --- | --- | --- | -| `lowBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | LowBound defines the lower bound of the range || x | | -| `highBound` _[Quantity](https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity)_ | HighBound defines the higher bound of the range || x | | +| `lowBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | LowBound defines the lower bound of the range || x | | +| `highBound` _[Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#quantity-resource-api)_ | HighBound defines the higher bound of the range || x | | #### Target