Merge pull request #814 from kannon92/move-samples

move samples to examples and update documentation
kubernetes-sigs · May 26, 2023 · 4338816 · 4338816
2 parents 909eab8 + a7953c0
commit 4338816
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -47,16 +47,16 @@ Read the [installation guide](https://kueue.sigs.k8s.io/docs/installation/) to l
 
 ## Usage
 
-A minimal configuration can be set by running the [samples](config/samples):
+A minimal configuration can be set by running the [examples](examples):
 
 ```shell
-kubectl apply -f config/samples/single-clusterqueue-setup.yaml
+kubectl apply -f examples/single-clusterqueue-setup.yaml
 ```
 
 Then you can run a job with:
 
 ```shell
-kubectl create -f config/samples/sample-job.yaml
+kubectl create -f examples/sample-job.yaml
 ```
 
 Learn more about:

diff --git a/config/samples/sample-job.yaml → examples/sample-job.yaml b/config/samples/sample-job.yaml → examples/sample-job.yaml
diff --git a/config/samples/sample-mpijob.yaml → examples/sample-mpijob.yaml b/config/samples/sample-mpijob.yaml → examples/sample-mpijob.yaml
diff --git a/...ig/samples/single-clusterqueue-setup.yaml → examples/single-clusterqueue-setup.yaml b/...ig/samples/single-clusterqueue-setup.yaml → examples/single-clusterqueue-setup.yaml
diff --git a/site/content/en/docs/tasks/administer_cluster_quotas.md b/site/content/en/docs/tasks/administer_cluster_quotas.md
@@ -25,10 +25,10 @@ In the following steps, you will create a queuing system with a single
 ClusterQueue and a single [ResourceFlavor](/docs/concepts/cluster_queue#resourceflavor-object)
 to govern the quota of your cluster.
 
-You can perform all these steps at once by applying [github.com/kubernetes-sigs/kueue/blob/main/config/samples/single-clusterqueue-setup.yaml](https://github.com/kubernetes-sigs/kueue/blob/main/config/samples/single-clusterqueue-setup.yaml):
+You can perform all these steps at once by applying [github.com/kubernetes-sigs/kueue/blob/main/examples/single-clusterqueue-setup.yaml](https://github.com/kubernetes-sigs/kueue/blob/main/examples/single-clusterqueue-setup.yaml):
 
 ```shell
-kubectl apply -f config/samples/single-clusterqueue-setup.yaml
+kubectl apply -f examples/single-clusterqueue-setup.yaml
 ```
 
 ### 1. Create a [ClusterQueue](/docs/concepts/cluster_queue)

diff --git a/site/content/en/docs/tasks/run_jobs.md b/site/content/en/docs/tasks/run_jobs.md
@@ -55,7 +55,7 @@ without Kueue. However, you must consider the following differences:
 - You should include the resource requests for each Job Pod.
 
 Here is a sample Job with three Pods that just sleep for a few seconds.
-This sample is also available in [github.com/kubernetes-sigs/kueue/blob/main/config/samples/sample-job.yaml](https://github.com/kubernetes-sigs/kueue/blob/main/config/samples/sample-job.yaml).
+This sample is also available in [github.com/kubernetes-sigs/kueue/blob/main/examples/sample-job.yaml](https://github.com/kubernetes-sigs/kueue/blob/main/examples/sample-job.yaml).
 
 ```yaml
 # sample-job.yaml