Skip to content

Commit 7c3973a

Browse files
authored
chore(docs): Cleaning up Top Level Docs pages (#7075)
* Update Community page * Clean up `helm-charts` folder's readme * Clean up Helm Charts doc page * Remove Radmap doc page and update link to the archived docs * Cleaning up home page (links, content) * Fix old link in the helm_charts.md docs * Fixing links on the home page * Remove mentioning of the slack channel in Community page * Fixed Overview of Components page * Add separate page with link to github releases * Fixed Overview of Components doc * Remove links to X from the community page * Fix link to the operator helm chart in the Advanced Helm Chart Configuration page * Update links for the core chart * Mention helm charts being published to github repo as well * Fix link to the License in the Home page * Fix link text * Fix link to python wrapper * Improve repetition
1 parent 08c0ab0 commit 7c3973a

File tree

9 files changed

+63
-125
lines changed

9 files changed

+63
-125
lines changed

docs-gb/README.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Seldon core converts your ML models (Tensorflow, Pytorch, H2o, etc.) or language
1919
Seldon handles scaling to thousands of production machine learning models and provides advanced machine learning capabilities out of the box including Advanced Metrics, Request Logging, Explainers, Outlier Detectors, A/B Tests, Canaries and more.
2020

2121
* Read the [Seldon Core Documentation](https://docs.seldon.ai/seldon-core-1)
22-
* Join our [community Slack](https://join.slack.com/t/seldondev/shared_invite/zt-vejg6ttd-ksZiQs3O_HOtPQsen_labg) to ask any questions
2322
* Get started with [Seldon Core Notebook Examples](notebooks/)
2423
* Learn how you can [start contributing](developer/contributing.md)
2524

@@ -29,12 +28,12 @@ Seldon handles scaling to thousands of production machine learning models and pr
2928

3029
With over 2M installs, Seldon Core is used across organisations to manage large scale deployment of machine learning models, and key benefits include:
3130

32-
* Easy way to containerise ML models using our [pre-packaged inference servers](servers/overview.md), [custom servers](servers/custom.md), or [language wrappers](https://docs.seldon.io/projects/seldon-core/en/1.18/wrappers/language_wrappers.html).
33-
* Out of the box endpoints which can be tested through [Swagger UI](https://docs.seldon.io/projects/seldon-core/en/latest/reference/apis/openapi.html?highlight=swagger), [Seldon Python Client or Curl / GRPCurl](wrappers/python/python_module.md#seldon-core-python-package).
34-
* Cloud agnostic and tested on [AWS EKS, Azure AKS, Google GKE, Alicloud, Digital Ocean and Openshift](notebooks/#cloud-specific-examples).
35-
* Powerful and rich inference graphs made out of [predictors, transformers, routers, combiners, and more](https://docs.seldon.io/projects/seldon-core/en/1.18/examples/graph-metadata.html).
31+
* Easy way to containerise ML models using our [pre-packaged inference servers](servers/overview.md), [custom servers](servers/custom.md), or [language wrappers](configuration/wrappers-and-sdks/README.md).
32+
* Out of the box endpoints which can be tested through [Swagger UI](reference/prediction-apis/prediction-open-api-spec/seldon-core-external-via-ambassador/README.md), [Seldon Python Client or Curl / GRPCurl](wrappers/python/python_module.md#seldon-core-python-package).
33+
* Cloud agnostic and tested on [AWS EKS, Azure AKS, Google GKE, Alicloud, Digital Ocean and Openshift](notebooks/README.md#cloud-specific-examples).
34+
* Powerful and rich inference graphs made out of [predictors, transformers, routers, combiners, and more](routing/inference-graph.md).
3635
* Metadata provenance to ensure each model can be traced back to its respective [training system, data and metrics](deployments/metadata.md)
37-
* Advanced and customisable metrics with integration [to Prometheus and Grafana](integrations/analytics.md).
36+
* Advanced and customisable metrics with integration to [Prometheus](integrations/analytics.md).
3837
* Full auditability through model input-output request [logging integration with Elasticsearch](reference/log_level.md).
3938
* Microservice distributed tracing through [integration to Jaeger](integrations/distributed-tracing.md) for insights on latency across microservice hops.
4039
* Secure, reliable and robust system maintained through a consistent [security & updates policy](../SECURITY.md).
@@ -146,7 +145,7 @@ class Model:
146145
return output
147146
```
148147

149-
We can now containerize our class file using the [Seldon Core s2i utils](https://docs.seldon.io/projects/seldon-core/en/1.18/wrappers/s2i.html) to produce the `sklearn_iris` image:
148+
We can now containerize our class file using the s2i utils to produce the `sklearn_iris` image:
150149

151150
```console
152151
s2i build . seldonio/seldon-core-s2i-python3:0.18 sklearn_iris:0.1
@@ -219,22 +218,19 @@ Below are some of the core components together with link to the logs that provid
219218
| <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/analytics"><br>Standard and custom metrics with prometheus<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/analytics/dashboard.png" alt=""></a></p> | <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/logging"><br>Full audit trails with ELK request logging<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/images/kibana-custom-search.png" alt=""></a></p> |
220219
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
221220
| <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/explainers"><br>Explainers for Machine Learning Interpretability<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/images/anchors.jpg" alt=""></a></p> | <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/outlier_detection"><br>Outlier and Adversarial Detectors for Monitoring<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/images/adversarial-attack.png" alt=""></a></p> |
222-
| <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/cicd-mlops"><br>CI/CD for MLOps at Massive Scale<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/images/cicd-seldon.jpg" alt=""></a></p> | <p><a href="https://docs.seldon.ai/seldon-core-1/configuration/integrations/distributed-tracing"><br>Distributed tracing for performance monitoring<br><br><img src="https://raw.githubusercontent.com/SeldonIO/seldon-core/master/doc/source/graph/jaeger-ui-rest-example.png" alt=""></a></p> |
223221

224222
## Where to go from here
225223

226224
### Getting Started
227225

228-
* [Quickstart Guide](./#getting-started)
229226
* [Overview of Components](overview.md)
230-
* [Install Seldon Core on Kubernetes](../install/installation.md)
231-
* [Join the Community](developer/community.md)
227+
* [Install Seldon Core on Kubernetes](install/installation.md)
232228

233229
### Seldon Core Deep Dive
234230

235-
* [Detailed Installation Parameters](https://docs.seldon.io/projects/seldon-core/en/latest/reference/helm.html)
231+
* [Detailed Installation Parameters](install/advanced-helm-chart-configuration.md)
236232
* [Pre-packaged Inference Servers](servers/overview.md)
237-
* [Language Wrappers for Custom Models](https://docs.seldon.io/projects/seldon-core/en/1.18/wrappers/language_wrappers.html)
233+
* [Language Wrappers for Custom Models](configuration/wrappers-and-sdks/README.md)
238234
* [Create your Inference Graph](routing/inference-graph.md)
239235
* [Deploy your Model](deployments/deploying.md)
240236
* [Testing your Model Endpoints](deployments/serving.md)
@@ -250,16 +246,21 @@ Below are some of the core components together with link to the logs that provid
250246
* [Tensorflow Serving](servers/tensorflow.md)
251247
* [XGBoost server](servers/xgboost.md)
252248

253-
### Language Wrappers (Production)
249+
### Language Wrappers
254250

255-
* [Python Language Wrapper \[Production\]](https://docs.seldon.io/projects/seldon-core/en/latest/python/index.html)
251+
#### Ready to use Wrappers
256252

257-
### Language Wrappers (Incubating)
253+
* [Python Language Wrapper](configuration/wrappers-and-sdks/python-language-wrapper/README.md)
258254

259-
* [Java Language Wrapper \[Incubating\]](wrappers/java.md)
260-
* [R Language Wrapper \[ALPHA\]](wrappers/r.md)
261-
* [NodeJS Language Wrapper \[ALPHA\]](wrappers/nodejs.md)
262-
* [Go Language Wrapper \[ALPHA\]](https://docs.seldon.io/projects/seldon-core/en/latest/go/go_wrapper_link.html)
255+
#### Other Examples
256+
257+
{% hint style="warning" %}
258+
Not suitable for production use - provided as examples only.
259+
{% endhint %}
260+
261+
* [Java Language Wrapper](wrappers/java.md)
262+
* [R Language Wrapper](wrappers/r.md)
263+
* [NodeJS Language Wrapper](wrappers/nodejs.md)
263264

264265
### Ingress
265266

@@ -292,22 +293,19 @@ Below are some of the core components together with link to the logs that provid
292293
* [Benchmarking](reference/benchmarking.md)
293294
* [General Availability](reference/ga.md)
294295
* [Helm Charts](reference/helm_charts.md)
295-
* [Images](https://docs.seldon.io/projects/seldon-core/en/latest/reference/images.html)
296+
* [Images](reference/images.md)
296297
* [Logging & Log Level](reference/log_level.md)
297298
* [Private Docker Registry](reference/private_registries.md)
298-
* [Prediction APIs](https://docs.seldon.io/projects/seldon-core/en/latest/reference/apis/index.html)
299-
* [Python API reference](https://docs.seldon.io/projects/seldon-core/en/latest/python/api/modules.html)
300-
* [Release Highlights](https://docs.seldon.io/projects/seldon-core/en/latest/reference/release-highlights.html)
301-
* [Seldon Deployment CRD ](reference/)(https://docs.seldon.io/projects/seldon-core/en/latest/reference/seldon-deployment.html)
299+
* [Prediction APIs](reference/prediction-apis/README.md)
300+
* [Release Highlights](reference/release-highlights/README.md)
301+
* [Seldon Deployment CRD ](reference/seldon-deployment-crd.md)
302302
* [Service Orchestrator](reference/svcorch.md)
303303
* [Kubeflow](reference/kubeflow.md)
304304

305305
### Developer
306306

307-
* [Overview](developer/)
308307
* [Contributing to Seldon Core](developer/contributing.md)
309308
* [End to End Tests](developer/e2e.md)
310-
* [Roadmap](developer/roadmap.md)
311309
* [Build using private repo](developer/buid-using-private-repo.md)
312310

313311
## About the name "Seldon Core"
@@ -320,4 +318,4 @@ To learn more about our commercial offerings visit [https://www.seldon.io/](http
320318

321319
## License
322320

323-
[License](LICENSE/)
321+
[License](./LICENSE.md)

docs-gb/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@
209209
spec: wrapper
210210
```
211211
* [Release Highlights](reference/release-highlights/README.md)
212+
* [Releases 1.8.0 and later](reference/release-highlights/later-releases.md)
212213
* [Release 1.7.0 Hightlights](reference/release-highlights/release-1.7.0.md)
213214
* [Release 1.6.0 Hightlights](reference/release-highlights/release-1.6.0.md)
214215
* [Release 1.5.0 Hightlights](reference/release-highlights/release-1.5.0.md)
@@ -224,13 +225,12 @@
224225
* [Seldon Deployment CRD](reference/seldon-deployment-crd.md)
225226
* [Service Orchestrator](reference/svcorch.md)
226227
* [Kubeflow](reference/kubeflow.md)
227-
* [Archived Docs](https://docs.seldon.io/projects/seldon-core/en/1.18/nav/archive.html)
228+
* [Archived Docs](https://github.com/SeldonIO/seldon-core/tree/v1.18.2/doc)
228229
229230
## Contributing
230231
231232
* [Overview](developer/readme.md)
232233
* [Seldon Core Licensing](developer/contributing.md)
233234
* [End to End Tests](developer/e2e.md)
234-
* [Roadmap](developer/roadmap.md)
235235
* [Build using Private Repo](developer/buid-using-private-repo.md)
236236
* [Seldon Docs Home](https://docs.seldon.ai/home)

docs-gb/developer/community.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,6 @@
11

22
# Seldon Core Community
33

4-
## Slack Channel
5-
6-
For any questions, as well as to keep up to date with any announcements please feel free to [join our Slack Channel through this link](https://join.slack.com/t/seldondev/shared_invite/zt-vejg6ttd-ksZiQs3O_HOtPQsen_labg).
7-
8-
## Working Group Calls
9-
10-
The Seldon Core team organises fornightly calls with the community to provide updates on current development, best practices and key findings such as tips on upgrading, backwards compatibility, etc.
11-
12-
The community call is also a great opportunity for the community to ask questions as well as suggestions around Seldon Core.
13-
14-
**Dates & times**
15-
16-
The dates for the community call is on Thursday every 2 weeks at 16:00 UK Time.
17-
18-
We always announce the community call in our Community Slack and social media so make sure you are able to join to stay up to date.
19-
20-
**Joining the call**
21-
22-
We use Zoom for the conference calls. Details can found:
23-
24-
* [Working Group Agenda Document](https://docs.google.com/document/d/1gAmiJoD-1NHSr0gvDQBhYGR5ryrgWVWRu3nOOxPdKJk/edit?usp=sharing)
25-
* [Google Calendar](https://calendar.google.com/event?action=TEMPLATE&tmeid=MmpzaWliOTQxdjEzbmduMTkyaHF0MnBpcGZfMjAyMTExMDRUMTYwMDAwWiBzZWxkb24uaW9fbTRuMnZtcmZubDI3M3FsczVnYjlwNjVpMHNAZw&tmsrc=seldon.io_m4n2vmrfnl273qls5gb9p65i0s%40group.calendar.google.com&scp=ALL)
26-
* [iCal](https://calendar.google.com/calendar/ical/seldon.io_m4n2vmrfnl273qls5gb9p65i0s%40group.calendar.google.com/public/basic.ics)
27-
28-
If you have any topics you would like to add or discuss, please feel free to add to the agenda point for the next meeting, or alternatively you can add an in-line comment.
29-
304
## Meetup
315

326
We organise a regular [MLOps Community Meetup](https://mlops.london/). The events are "hybrid"; feel free to attend in person if you're near to London or otherwise follow the [YouTube Channel](https://www.youtube.com/channel/UCSBfllj_pRPB36TAZJfjXWg).
33-
34-
## X (formerly Twitter)
35-
36-
Follow our [Seldon](https://x.com/seldon_io) account on X (formerly Twitter) for product releases and announcements. We also have [Seldon Research](https://x.com/SeldonResearch) for the latest in research around Drift/Outlier Detection and Explainability.

docs-gb/developer/roadmap.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs-gb/install/advanced-helm-chart-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This page provides a detailed overview of the installation parameters available for the Seldon Core installation when using Helm 3.x. The high level workflows to install Seldon Core can be found in the [Installation Page](../workflow/install.md).
66

7-
You can find the `values.yaml` file of the [seldon-core-operator Helm chart](https://github.com/SeldonIO/seldon-core/helm-charts/seldon-core-operator), which contains basically all the values that you can configure in your installation by using the `set` flag in the format `--set value.path=YOUR_VALUE`.
7+
You can find the `values.yaml` file of the [seldon-core-operator Helm chart](https://github.com/SeldonIO/seldon-core/tree/master/helm-charts/seldon-core-operator), which contains basically all the values that you can configure in your installation by using the `set` flag in the format `--set value.path=YOUR_VALUE`.
88

99
The file has been written to be self documented, and has information on all the core parameters. Further information is referenced in the file to specific documentation pages.
1010

docs-gb/overview.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Overview of Components
22

3-
Seldon core converts your ML models into production ready REST/gRPC microservices.
4-
5-
These are Seldon Core main components:
3+
Seldon core converts your ML models into production ready REST/gRPC microservices. It comprises of several main components:
64

75
* Reusable and non-reusable [model servers](overview.md#e2e-serving-with-model-servers)
86
* [Language Wrappers](overview.md#language-wrappers) to containerise models
9-
* [SeldonDeployment](overview.md#seldondeployment-crd) CRD and [Seldon Core Operator](overview.md#seldon-core-operator)
7+
* [SeldonDeployment](overview.md#seldon-deployment-crd) CRD and [Seldon Core Operator](overview.md#seldon-core-operator)
108
* [Service Orchestrator](overview.md#service-orchestrator) for advanced inference graphs
119

1210
as well as integration with third-party systems:
1311

1412
* Kubernetes Ingress integration with [Ambassador](https://www.getambassador.io/) and [Istio](https://istio.io/)
1513
* [Metrics](overview.md#metrics-with-prometheus) with [Prometheus](https://prometheus.io/)
1614
* [Tracing](overview.md#distributed-tracing-with-jaeger) with [Jaeger](https://www.jaegertracing.io/)
17-
* [Endpoint Documentation](overview.md#endpoint-documentation) with [OpenApi](https://swagger.io/docs/specification/about/)
15+
* [Endpoint Documentation](reference/prediction-apis/prediction-open-api-spec/) with [OpenApi](https://swagger.io/docs/specification/about/)
1816

1917
Keep reading to learn more!
2018

@@ -47,12 +45,12 @@ With Seldon Core you can build two type of servers: reusable and non-reusable on
4745

4846
Read more about our pre-packaged `Model Servers` on their dedicated documentation pages:
4947

50-
* [MLflow Server](../servers/mlflow.html)
51-
* [SKLearn Server](../servers/sklearn.html)
52-
* [Tensorflow Server](../servers/tensorflow.html)
53-
* [XGBoost Server](../servers/xgboost.html)
48+
* [MLflow Server](servers/mlflow.md)
49+
* [SKLearn Server](servers/sklearn.md)
50+
* [Tensorflow Server](servers/tensorflow.md)
51+
* [XGBoost Server](servers/xgboost.md)
5452

55-
Read how to build your own pre-packaged model server [here](../servers/custom.html).
53+
Read how to build your own pre-packaged model server [here](servers/custom.md).
5654

5755
## Language Wrappers
5856

@@ -113,7 +111,7 @@ s2i build . seldonio/seldon-core-s2i-python<PYTHON VERSION>:<TAG> model:0.1
113111

114112
to create ready to use Docker image.
115113

116-
Read more about Python [Language Wrapper on its dedicated documentation page](../python/index.html).
114+
Read more about Python [Language Wrapper on its dedicated documentation page](wrappers/python/python_module.md).
117115

118116
## Seldon Deployment CRD
119117

@@ -127,7 +125,7 @@ The manifest file that you write is very powerful yet simple. You can easily def
127125

128126
You can think about the CRD as an abstraction around the actual deployment and services that are created in the cluster. Once the manifest is applied to the cluster, Seldon Core `Operator` creates all Kubernetes objects required to serve the inference requests.
129127

130-
Read more about [Seldon Deployment CRD on its dedicated documentation page](../reference/seldon-deployment.html).
128+
Read more about [Seldon Deployment CRD on its dedicated documentation page](reference/seldon-deployment-crd.md).
131129

132130
## Seldon Core Operator
133131

@@ -157,7 +155,7 @@ It is because of the presence of `Service Orchestrator` that complex graph compo
157155

158156
to just name a few.
159157

160-
Read more about [Service Orchestrator on its dedicated documentation page](../graph/svcorch.html).
158+
Read more about [Service Orchestrator on its dedicated documentation page](reference/svcorch.md).
161159

162160
## Metadata Provenance
163161

@@ -167,23 +165,23 @@ These allow you to make connection to the platform you trained your model with (
167165

168166
![](.gitbook/assets/metadata.svg)
169167

170-
Read more about [metadata provenance on its dedicated documentation page](../reference/apis/metadata.html).
168+
Read more about [metadata provenance on its dedicated documentation page](deployments/metadata.md).
171169

172170
## Metrics with Prometheus
173171

174172
Metrics is important aspect of serving ML inference models in production. Out of the box Seldon Core deployments expose standard metrics to [Prometheus](https://prometheus.io/) on the `Service Orchestrator`.
175173

176174
![](.gitbook/assets/metrics.png)
177175

178-
Read more about [metrics on its dedicated documentation page](../analytics/analytics.html).
176+
Read more about [metrics on its dedicated documentation page](integrations/analytics.md).
179177

180178
## Distributed Tracing with Jaeger
181179

182180
By default, we support [Jaeger](https://www.jaegertracing.io/) for Distributed Tracing.
183181

184182
![](.gitbook/assets/tracing.svg)
185183

186-
Read more about [tracing on its dedicated documentation page](../graph/distributed-tracing.html).
184+
Read more about [tracing on its dedicated documentation page](integrations/distributed-tracing.md).
187185

188186
## So.... Why just not wrap my model with Flask?
189187

0 commit comments

Comments
 (0)