Skip to content

Commit 980b3b5

Browse files
Rajakavitha1Rakavitha Kodhandapani
andauthored
docs(multiplepages): fixed broken links (#6914)
* fixed brokenlinks 1 * fixed the broken links * removed the reference to docker compose * fixed the https links * fixed the link sto the guides * fixed teh broken links * fixed the broken links --------- Co-authored-by: Rakavitha Kodhandapani <seldon@SELIN002.local>
1 parent 50c30fa commit 980b3b5

File tree

10 files changed

+15
-34
lines changed

10 files changed

+15
-34
lines changed

docs-gb/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ make build-seldon-arm # for macOS ARM
1111

1212
Then place the `bin/seldon` executable in your path.
1313

14-
* [cli docs](./docs/seldon.md)
14+
* [cli docs](../cli/seldon.md)
1515

1616

1717
## Environment Variables and Services

docs-gb/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This section will provide some examples to allow operations with Seldon to be te
6565
## Misc
6666

6767
* [Checking Pipeline readiness](pipeline-ready-and-metadata.md)
68-
* [Local Overcommit](local-overcommit-examples/)
68+
* [Local Overcommit](local-overcommit-examples.md)
6969

7070
## Further Kubernetes Examples
7171

docs-gb/kubernetes/kafka.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ We currently have tested and documented integration with following managed solut
2727
- Amazon MSK (security: SASL/SCRAM)
2828
- Azure Event Hub (security: SASL/PLAIN)
2929

30-
See our [Kafka security](../getting-started/kubernetes-installation/security.md#kafka)
31-
section for configuration examples.
30+
See our [Kafka security](../getting-started/kubernetes-installation/security/README.md#kafka) section for configuration examples.
3231

3332
## Self Hosted Kafka
3433

@@ -39,7 +38,7 @@ To install Kafka for testing purposed in your k8s cluster, we recommend to use [
3938

4039
{% hint style="info" %}
4140
**Note**: This page discuss how to install Strimzi Operator and create Kafka cluster for trial, dev, or testing purposes.
42-
For production grade installation consult [Strimzi documentation](https://strimzi.io/documentation/) or use one of managed solutions mentioned [here](./index.md).
41+
For production grade installation consult [Strimzi documentation](https://strimzi.io/documentation/) or use one of [managed solutions](#managed-kafka).
4342
{% endhint %}
4443

4544
You can install and configure Strimzi using either Helm charts or our Ansible playbooks, both documented below.
@@ -93,4 +92,4 @@ ansible-playbook playbooks/setup-ecosystem.yaml -e full_install=no -e install_ka
9392
## Notes
9493
- You can check [kafka-examples](https://github.com/strimzi/strimzi-kafka-operator/tree/main/examples/kafka) for more details.
9594
- As we are using [KRaft](https://kafka.apache.org/documentation/#kraft), use Kafka version 3.4 or above.
96-
- For security settings check [here](../getting-started/kubernetes-installation/security.md#kafka).
95+
- For security settings check [here](../getting-started/kubernetes-installation/security/README.md#kafka).

docs-gb/kubernetes/metrics.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ provides an all-in-one package with the [Prometheus operator](https://github.com
1414

1515
### RBAC
1616

17-
You will need to modify the default RBAC installed by kube-prometheus as described
18-
[here](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#deploying-prometheus).
17+
You will need to modify the default [RBAC installed by kube-prometheus](https://prometheus-operator.dev/docs/getting-started/introduction/).
1918

2019
From the `prometheus` folder in the project run:
2120

@@ -45,8 +44,8 @@ reference [this](https://github.com/prometheus-operator/prometheus-operator/issu
4544

4645
## Example Grafana Dashboard
4746

48-
Check [metrics](../metrics.md) for more information.
47+
Check [metrics](../operational-monitoring/observability.md) for more information.
4948

5049
## Reference
5150

52-
[Prometheus CRDs](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md)
51+
[Prometheus CRDs](https://prometheus-operator.dev/docs/api-reference/api/)

docs-gb/metrics/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Metrics
22

33
There are two kinds of metrics present in Seldon Core 2:
4-
* [operational metrics](./operational.md)
5-
* [usage metrics](./usage.md)
4+
* [operational metrics](../operational-monitoring/operational.md)
5+
* [usage metrics](../operational-monitoring/usage.md)
66

77
Operational metrics describe the performance of components in the system. Some examples of common operational
88
considerations are memory consumption and CPU usage, request latency and throughput, and cache utilisation rates.

docs-gb/models/rclone.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,4 @@ We utilize [Rclone](https://rclone.org/) to copy model artifacts from a storage
1010
to the model servers. This allows users to take advantage of Rclones support for over 40\
1111
cloud storage backends including Amazon S3, Google Storage and many others.
1212

13-
For local storage while developing see [here](../getting-started/docker-installation.md#local-models).
14-
15-
For authorization needed for cloud storage when running on Kubernetes see [here](../../kubernetes/storage-secrets.md).
13+
For authorization needed for cloud storage when running on Kubernetes see [here](../kubernetes/storage-secrets.md).

docs-gb/operational-monitoring/observability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description:nInstalling kube-prometheus-stack in the same Kubernetes cluster that hosts the
2+
description: Installing kube-prometheus-stack in the same Kubernetes cluster that hosts the
33
Seldon Core 2.
44
---
55

docs-gb/operational-monitoring/usage.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following environment variables control the behaviour of Hodometer, regardle
5656
| Flag | Format | Example | Description |
5757
| -------------------- | ---------------------------- | --------------------------------------------------- | -------------------------------------------------------------------------------- |
5858
| `METRICS_LEVEL` | string | feature | Level of detail for recorded metrics; one of `feature`, `resource`, or `cluster` |
59-
| `EXTRA_PUBLISH_URLS` | comma-separated list of URLs | http://my-endpoint-1:8000,http://my-endpoint-2:8000 | Additional endpoints to publish metrics to |
59+
| `EXTRA_PUBLISH_URLS` | comma-separated list of URLs | `http://<my-endpoint-1>:8000`,`http://<my-endpoint-2>:8000` | Additional endpoints to publish metrics to |
6060
| `SCHEDULER_HOST` | string | seldon-scheduler | Hostname for Seldon Core v2 scheduler |
6161
| `SCHEDULER_PORT` | integer | 9004 | Port for Seldon Core v2 scheduler |
6262
| `LOG_LEVEL` | string | info | Level of detail for application logs |
@@ -92,21 +92,6 @@ helm install seldon-v2-runtime k8s/helm-charts/seldon-core-v2-runtime \
9292
These can be applied by using the `-f <filename>` switch when running Helm.
9393
{% endhint %}
9494

95-
### Docker Compose
96-
97-
The [Compose setup](../getting-started/docker-installation/index.md) provides a pre-configured and opinionated,\
98-
yet still flexible, approach to using Seldon Core v2.
99-
100-
Hodometer is defined as a service called `hodometer` in the Docker Compose manifest. It is automatically enabled\
101-
when running as per the installation instructions.
102-
103-
You can disable Hodometer in Docker Compose by removing the corresponding service from the base manifest.\
104-
Alternatively, you can gate it behind a [profile](https://docs.docker.com/compose/profiles/).\
105-
If the service is already running, you can stop it directly using `docker-compose stop ...`.
106-
107-
Configuration can be provided by environment variables when running `make` or directly invoking `docker-compose`.\
108-
The available variables are defined in the Docker Compose environment file, prefixed with `HODOMETER_`.
109-
11095
### Extra publish URLs
11196

11297
Hodometer can be instructed to publish metrics not only to Seldon, but also to any extra endpoints you specify.\

docs-gb/servers/servers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ For some examples see [here](../examples/custom-servers.md).
110110

111111
## Autoscaling of Servers
112112

113-
Within docker we don't support this but for Kubernetes see [here](../kubernetes/autoscaling/)
113+
Within docker we don't support this but for Kubernetes see [here](../scaling/README.md)

docs-gb/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Previously, the labelling has been inconsistent across different versions of Sel
3939
mixture of `app` and `app.kubernetes.io/name` used.
4040

4141
If using the Prometheus operator ("Kube Prometheus"), please apply the v2.7.0 manifests for Seldon Core 2\
42-
according to the [metrics documentation](../kubernetes/metrics.md).
42+
according to the [metrics documentation](../docs-gb/kubernetes/metrics.md).
4343

4444
Note that these manifests need to be adjusted to discover metrics endpoints based on the existing setup.
4545

0 commit comments

Comments
 (0)