Skip to content

Commit

Permalink
docs: fix some broken links (#3647)
Browse files Browse the repository at this point in the history
Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
  • Loading branch information
mowies authored Aug 5, 2024
1 parent 566e163 commit b1dd064
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions docs/docs/getting-started/lifecycle-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/reference/api-reference/metrics/v1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can<br />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 | |


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/reference/api-reference/metrics/v1alpha3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can<br />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 | |


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/reference/api-reference/metrics/v1beta1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />a combination of 'from' and 'to' or the 'recent' property may be set. If neither is set, the Analysis can<br />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 | |


Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b1dd064

Please sign in to comment.