From 8e582cee106ac0ed4c19621e2fa3979d1c03d8fe Mon Sep 17 00:00:00 2001 From: Aria Marble <111301581+ariamarble@users.noreply.github.com> Date: Thu, 2 Feb 2023 09:15:27 -0800 Subject: [PATCH] cluster api toc update (#2573) Signed-off-by: ariamarble (cherry picked from commit 0b9f2c866fc2a591dc4f4c36685dcea4777e16c8) --- .../{ => cluster-api}/cluster-allocation.md | 4 +++- .../{ => cluster-api}/cluster-awareness.md | 4 +++- .../{ => cluster-api}/cluster-decommission.md | 4 +++- _api-reference/{ => cluster-api}/cluster-health.md | 4 +++- _api-reference/{ => cluster-api}/cluster-settings.md | 4 +++- _api-reference/{ => cluster-api}/cluster-stats.md | 4 +++- _api-reference/cluster-api/index.md | 12 ++++++++++++ 7 files changed, 30 insertions(+), 6 deletions(-) rename _api-reference/{ => cluster-api}/cluster-allocation.md (98%) rename _api-reference/{ => cluster-api}/cluster-awareness.md (98%) rename _api-reference/{ => cluster-api}/cluster-decommission.md (97%) rename _api-reference/{ => cluster-api}/cluster-health.md (99%) rename _api-reference/{ => cluster-api}/cluster-settings.md (99%) rename _api-reference/{ => cluster-api}/cluster-stats.md (99%) create mode 100644 _api-reference/cluster-api/index.md diff --git a/_api-reference/cluster-allocation.md b/_api-reference/cluster-api/cluster-allocation.md similarity index 98% rename from _api-reference/cluster-allocation.md rename to _api-reference/cluster-api/cluster-allocation.md index bc73cfb0180..31b55537564 100644 --- a/_api-reference/cluster-allocation.md +++ b/_api-reference/cluster-api/cluster-allocation.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster allocation explain -nav_order: 15 +nav_order: 10 +parent: Cluster APIs +has_children: false --- # Cluster allocation explain diff --git a/_api-reference/cluster-awareness.md b/_api-reference/cluster-api/cluster-awareness.md similarity index 98% rename from _api-reference/cluster-awareness.md rename to _api-reference/cluster-api/cluster-awareness.md index e6dc7205bf8..8e7073d965a 100644 --- a/_api-reference/cluster-awareness.md +++ b/_api-reference/cluster-api/cluster-awareness.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster routing and awareness -nav_order: 16 +nav_order: 20 +parent: Cluster APIs +has_children: false --- # Cluster routing and awareness diff --git a/_api-reference/cluster-decommission.md b/_api-reference/cluster-api/cluster-decommission.md similarity index 97% rename from _api-reference/cluster-decommission.md rename to _api-reference/cluster-api/cluster-decommission.md index 698cec7ed96..6d0fcec3d80 100644 --- a/_api-reference/cluster-decommission.md +++ b/_api-reference/cluster-api/cluster-decommission.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster decommission -nav_order: 20 +nav_order: 30 +parent: Cluster APIs +has_children: false --- # Cluster decommission diff --git a/_api-reference/cluster-health.md b/_api-reference/cluster-api/cluster-health.md similarity index 99% rename from _api-reference/cluster-health.md rename to _api-reference/cluster-api/cluster-health.md index a54dbea15a0..a87b796dc63 100644 --- a/_api-reference/cluster-health.md +++ b/_api-reference/cluster-api/cluster-health.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster health -nav_order: 17 +nav_order: 40 +parent: Cluster APIs +has_children: false --- # Cluster health diff --git a/_api-reference/cluster-settings.md b/_api-reference/cluster-api/cluster-settings.md similarity index 99% rename from _api-reference/cluster-settings.md rename to _api-reference/cluster-api/cluster-settings.md index 070ee59d914..96375ab094b 100644 --- a/_api-reference/cluster-settings.md +++ b/_api-reference/cluster-api/cluster-settings.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster settings -nav_order: 18 +nav_order: 50 +parent: Cluster APIs +has_children: false --- # Cluster settings diff --git a/_api-reference/cluster-stats.md b/_api-reference/cluster-api/cluster-stats.md similarity index 99% rename from _api-reference/cluster-stats.md rename to _api-reference/cluster-api/cluster-stats.md index cba70157087..8097c27cd6a 100644 --- a/_api-reference/cluster-stats.md +++ b/_api-reference/cluster-api/cluster-stats.md @@ -1,7 +1,9 @@ --- layout: default title: Cluster stats -nav_order: 18 +nav_order: 60 +parent: Cluster APIs +has_children: false --- # Cluster stats diff --git a/_api-reference/cluster-api/index.md b/_api-reference/cluster-api/index.md new file mode 100644 index 00000000000..9ce04695f62 --- /dev/null +++ b/_api-reference/cluster-api/index.md @@ -0,0 +1,12 @@ +--- +layout: default +title: Cluster APIs +has_children: true +nav_order: 15 +redirect_from: + - /opensearch/api-reference/cluster-api/ +--- + +# Cluster APIs + +The cluster APIs allow you to manage your cluster. You can use them to check cluster health, modify settings, retrieve statistics, and more.