From 1861dc008ca594aa8927187d4c555e746fe3e8d4 Mon Sep 17 00:00:00 2001 From: Yaron Date: Tue, 6 Aug 2024 09:07:29 +0300 Subject: [PATCH 1/2] reference-replacement --- docs/developer/cluster-api/reference.md | 2 ++ docs/developer/cluster-api/submit-yaml.md | 2 +- .../cluster-api => graveyard}/reference/distributed.md | 0 .../cluster-api => graveyard}/reference/inference.md | 0 .../cluster-api => graveyard}/reference/interactive.md | 0 .../cluster-api => graveyard}/reference/training.md | 0 mkdocs.yml | 6 +----- 7 files changed, 4 insertions(+), 6 deletions(-) create mode 100644 docs/developer/cluster-api/reference.md rename {docs/developer/cluster-api => graveyard}/reference/distributed.md (100%) rename {docs/developer/cluster-api => graveyard}/reference/inference.md (100%) rename {docs/developer/cluster-api => graveyard}/reference/interactive.md (100%) rename {docs/developer/cluster-api => graveyard}/reference/training.md (100%) diff --git a/docs/developer/cluster-api/reference.md b/docs/developer/cluster-api/reference.md new file mode 100644 index 0000000000..190378e24f --- /dev/null +++ b/docs/developer/cluster-api/reference.md @@ -0,0 +1,2 @@ + +For a full reference for the YAML API parameters see the [YAML Reference](Workload-YAML-Reference-v1.pdf). \ No newline at end of file diff --git a/docs/developer/cluster-api/submit-yaml.md b/docs/developer/cluster-api/submit-yaml.md index 0e5743a775..ef00066977 100644 --- a/docs/developer/cluster-api/submit-yaml.md +++ b/docs/developer/cluster-api/submit-yaml.md @@ -3,7 +3,7 @@ You can use YAML to submit Workloads directly to Run:ai. Below are examples of how to create training, interactive and inference workloads via YAML. -For details on YAML parameters, see the [YAML Reference](Workload-YAML-Reference-v1.pdf). +For details on YAML parameters, see the [YAML Reference](reference.md). ## Submit Workload Example diff --git a/docs/developer/cluster-api/reference/distributed.md b/graveyard/reference/distributed.md similarity index 100% rename from docs/developer/cluster-api/reference/distributed.md rename to graveyard/reference/distributed.md diff --git a/docs/developer/cluster-api/reference/inference.md b/graveyard/reference/inference.md similarity index 100% rename from docs/developer/cluster-api/reference/inference.md rename to graveyard/reference/inference.md diff --git a/docs/developer/cluster-api/reference/interactive.md b/graveyard/reference/interactive.md similarity index 100% rename from docs/developer/cluster-api/reference/interactive.md rename to graveyard/reference/interactive.md diff --git a/docs/developer/cluster-api/reference/training.md b/graveyard/reference/training.md similarity index 100% rename from docs/developer/cluster-api/reference/training.md rename to graveyard/reference/training.md diff --git a/mkdocs.yml b/mkdocs.yml index 13a2ff1825..1d125ab314 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -383,11 +383,7 @@ nav: - 'Submit CRON job via YAML' : 'developer/cluster-api/submit-cron-yaml.md' - 'Kubernetes Workloads' : 'developer/cluster-api/other-resources.md' - 'Data Volumes': 'developer/admin-rest-api/data-volumes.md' - - 'Reference' : - - 'Training Workloads' : 'developer/cluster-api/reference/training.md' - - 'Interactive Workloads' : 'developer/cluster-api/reference/interactive.md' - - 'Distributed Training Workloads' : 'developer/cluster-api/reference/distributed.md' - - 'Inference Workloads' : 'developer/cluster-api/reference/inference.md' + - 'Reference' : 'developer/cluster-api/reference.md' - 'Control Plane API' : 'developer/admin-rest-api/overview.md' - 'Metrics API' : - 'Metrics' : 'developer/metrics/metrics.md' From eaf4a7d77c4d44bf19043af1f31d8dde1eeb9a2f Mon Sep 17 00:00:00 2001 From: Yaron Date: Tue, 6 Aug 2024 09:11:54 +0300 Subject: [PATCH 2/2] reference-replacement --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 1d125ab314..2169b6facb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -376,6 +376,7 @@ nav: - 'Developer' : - 'Overview' : 'developer/overview-developer.md' - 'API Authentication' : 'developer/rest-auth.md' + - 'Control Plane API' : 'developer/admin-rest-api/overview.md' - 'Cluster API' : - 'Workloads Overview' : 'developer/cluster-api/workload-overview-dev.md' - 'Submit Workload via YAML' : 'developer/cluster-api/submit-yaml.md' @@ -384,7 +385,6 @@ nav: - 'Kubernetes Workloads' : 'developer/cluster-api/other-resources.md' - 'Data Volumes': 'developer/admin-rest-api/data-volumes.md' - 'Reference' : 'developer/cluster-api/reference.md' - - 'Control Plane API' : 'developer/admin-rest-api/overview.md' - 'Metrics API' : - 'Metrics' : 'developer/metrics/metrics.md' - 'Deprecated APIs' :