Fix docs warnings

kanisterio · Sep 17, 2024 · f3b2e13 · f3b2e13
1 parent e64a65b
commit f3b2e13
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/functions.rst b/docs/functions.rst
@@ -154,7 +154,7 @@ KubeTaskParallel
 ----------------
 
 KubeTaskParallel spins up a new pod with two containers connected
-via shared emptyDir volume.
+via shared `emptyDir`_ volume.
 It's similar to KubeTask, but allows using multiple images to move backup data.
 "background" container is one responsible for generating data, while "output" container
 should export it to destination.
@@ -177,12 +177,12 @@ The function also supports an optional init container to set up the volume conte
    `podOverride`, No, `map[string]interface{}`, specs to override default pod specs with
    `podAnnotations`, No, `map[string]string`, custom annotations for the temporary pod that gets created
    `podLabels`, No, `map[string]string`, custom labels for the temporary pod that gets created
-   `sharedVolumeMedium`, No, `string`, medium setting for shared volume. See the Kubernetes `documentation
-<https://kubernetes.io/docs/concepts/storage/volumes/#emptydir>`_.
-   `sharedVolumeSizeLimit`, No, `string`, sizeLimit setting for shared volume. See the Kubernetes `documentation
-<https://kubernetes.io/docs/concepts/storage/volumes/#emptydir>`_.
+   `sharedVolumeMedium`, No, `string`, medium setting for shared volume. See `emptyDir`_.
+   `sharedVolumeSizeLimit`, No, `string`, sizeLimit setting for shared volume. See `emptyDir`_.
    `sharedVolumeDir`, No, `string`, directory to mount shared volume. Defaults to `/tmp`
 
+.. _emptyDir: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+
 Example:
 
 .. code-block:: yaml

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -65,4 +65,4 @@ kopia
 hostname
 emptyDir
 sizeLimit
-init
+init
diff --git a/docs_new/functions.md b/docs_new/functions.md
@@ -131,7 +131,7 @@ Example:
 
 ### KubeTaskParallel
 
-KubeTaskParallel spins up a new pod with two containers connected via shared emptyDir volume.
+KubeTaskParallel spins up a new pod with two containers connected via shared [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume.
 It's similar to KubeTask, but allows using multiple images to move backup data.
 "background" container is one responsible for generating data, while "output" container
 should export it to destination.
@@ -152,8 +152,8 @@ The function also supports an optional init container to set up the volume conte
   | podOverride           | No  | map[string]interface{}  | specs to override default pod specs with |
   | podAnnotations        | No  | map[string]string | custom annotations for the temporary pod that gets created |
   | podLabels             | No  | map[string]string | custom labels for the temporary pod that gets created |
-  | sharedVolumeMedium    | No  | string            |  medium setting for shared volume. See the Kubernetes [documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). |
-  | sharedVolumeSizeLimit | No  | string            | sizeLimit setting for shared volume. See the Kubernetes [documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). |
+  | sharedVolumeMedium    | No  | string            |  medium setting for shared volume. See [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). |
+  | sharedVolumeSizeLimit | No  | string            | sizeLimit setting for shared volume. See [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). |
   | sharedVolumeDir       | No  | string            | directory to mount shared volume, defaults to `/tmp` |