Skip to content

Commit 0ec15f4

Browse files
Small docs tweaks (#505)
1 parent f6361be commit 0ec15f4

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

doc/source/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,10 @@
189189

190190

191191
# Example configuration for intersphinx: refer to the Python standard library.
192-
intersphinx_mapping = {"https://docs.python.org/": None}
192+
intersphinx_mapping = {
193+
"python": ("https://docs.python.org/3", None),
194+
"dask": ("https://docs.dask.org/en/latest/", None),
195+
"distributed": ("https://distributed.dask.org/en/latest/", None),
196+
}
193197

194198
redirects = {}

doc/source/operator.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Overview
88
What is the operator?
99
---------------------
1010

11-
The Dask Operator is a small service that runs on your Kubernetes cluster and allows you to create and manage your Dask clusters as native Kubernetes resources.
11+
The Dask Operator is a small service that runs on your Kubernetes cluster and allows you to create and manage your Dask clusters as Kubernetes resources.
1212
Creating clusters can either be done via the :doc:`Kubernetes API with kubectl <operator_resources>` or the :doc:`Python API with the experimental KubeCluster <operator_kubecluster>`.
1313

14-
To :doc:`install the operator <operator_installation>` you needs to install some custom resource definitions that allow us to describe Dask resources and the operator itself which is a small Python application that
14+
To :doc:`install the operator <operator_installation>` you needs to apply some custom resource definitions that allow us to describe Dask resources and the operator itself which is a small Python application that
1515
watches the Kubernetes API for events related to our custom resources and creates other resources such as ``Pods`` and ``Services`` accordingly.
1616

1717
What resources does the operator manage?

doc/source/operator_kubecluster.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ KubeCluster (experimental)
88
Cluster manager
99
---------------
1010

11-
The operator has a new cluster manager called :class:`dask_kubernetes.experimental.KubeCluster` that you can use to conveniently create and manage a Dask cluster in Python. Then connect a :class:`dask.distributed.Client` object to it directly and perform your work.
11+
The operator has a new cluster manager called :class:`dask_kubernetes.experimental.KubeCluster` that you can use to conveniently create and manage a Dask cluster in Python. Then connect a Dask :class:`distributed.Client` object to it directly and perform your work.
1212

1313
The goal of the cluster manager is to abstract away the complexity of the Kubernetes resources and provide a clean and simple Python API to manager clusters while still getting all the benefits of the operator.
1414

doc/source/operator_resources.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,6 @@ Let's create an example called ``cluster.yaml`` with the following configuration
6565
imagePullPolicy: "IfNotPresent"
6666
args:
6767
- dask-worker
68-
# Note the name of the cluster service, which adds "-service" to the end
69-
- tcp://simple-cluster-service.default.svc.cluster.local:8786
7068
- --name
7169
- $(DASK_WORKER_NAME)
7270
scheduler:

0 commit comments

Comments
 (0)