From 6a7c56d68ee65d82f95e22fb7018b2845a74db91 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 14 Jun 2024 14:43:49 +0200 Subject: [PATCH 1/5] Second PR for transforming the README.md file into something of a proper Table of Contents. --- content/releases/README.md | 43 +++++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 3ee849f8..9ad36954 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -2,22 +2,44 @@ ## MKE 4 +### Concepts and Architecture + +- [Architecture](../docs/concepts/architecture/architecture.md) +- [Configuration](../docs/concepts/architecture/configuration.md) +- [Migrate configuration](../docs/concepts/architecture/migrate-configuration.md) ### Setup -[Install mkectl](../docs/setup/getting-started/install-mke4-cli.md) -[Get Started with MKE 4](../docs/setup/getting-started/create-a-cluster.md) +- [Get Started with MKE 4](../docs/setup/getting-started/README.md) + - [Prerequisites](../docs/setup/getting-started/prerequisites.md) + - [Create a cluster](../docs/setup/getting-started/create-a-cluster.md) + - [Using the cluster](../docs/setup/getting-started/using-the-cluster.md) + - [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md) + - [Uninstallation](../docs/setup/getting-started/uninstallation.md) +- [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md) + +### Reference + +- [Authentication](../docs/reference/authentication/authentication.md) +- [Backup and restore](../docs/reference/backuprestore/backup-restore.md) +- [Ingress controller](../docs/reference/ingress/ingress-controller.md) +- [Monitoring](../docs/reference/monitoring/monitoring.md) +- [Support bundle](../docs/reference/supportbundle/support-bundle.md) -[Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/perform-upgrade.md) +### Known issues + +- [Known issues](known-issues.md) ### Features -This table summarizes MKE 4 features, their status, and links to guides + +The table that follows details MKE 4 features and their current status. In +addition, where applicable, the table offers links to associated documentation. | Feature | Pre-Release | Status | |------------------------------------------------------------------|-------|----------| -| [Authentication](../docs/reference/authentication/README.md) | alpha.1| MVP | -| Authorization | | | -| [Backup & Restore](../docs/reference/backuprestore/backup-restore.md) | alpha.1 | MVP | +| Authentication | alpha.1| MVP | +| Authorization | alpha.1 | MVP | +| [Backup and restore](../docs/reference/backuprestore/backup-restore.md) | alpha.1 | MVP | | CIS Benchmark | | | | CLI | | | | Cloud Providers | | | @@ -30,19 +52,16 @@ This table summarizes MKE 4 features, their status, and links to guides | Life Cycle Management | | | | Licensing | | | | Load Balancing | | | -| [Logging, Monitoring and Alerting](../docs/reference/monitoring/monitoring.md) | alpha.1 | MVP | +| Logging, Monitoring and Alerting | alpha.1 | MVP | | [Networking (CNI)](../docs/concepts/architecture/README.md#CNI) | alpha.1 | MVP | | Node Feature Discovery | | | | Offline Bundle | | | | OpsCare | | | | Policy Controller | | | | Storage (CSI) | | | -| [Support Dump](../docs/reference/supportbundle/support-bundle.md) | alpha.1 | | +| Support Dump | | | | Telemetry | | | | TLS | | | | 2FA | | | | Web UI | alpha 2 | | | Windows | | | - -### Known Issues -[Known Issues for alpha.1](../docs/known-issues.md) From c1720dd184092283194757cb1795399398f0e04c Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 14 Jun 2024 15:00:51 +0200 Subject: [PATCH 2/5] Fix errant links as reported by Linkspector --- content/releases/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 9ad36954..76bd55b8 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -10,13 +10,14 @@ ### Setup -- [Get Started with MKE 4](../docs/setup/getting-started/README.md) +- Get Started with MKE 4 - [Prerequisites](../docs/setup/getting-started/prerequisites.md) - [Create a cluster](../docs/setup/getting-started/create-a-cluster.md) - [Using the cluster](../docs/setup/getting-started/using-the-cluster.md) + - [nstall MKE 4 CLI](../docs/setup/getting-started/install-mke4-cli.md) - [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md) - [Uninstallation](../docs/setup/getting-started/uninstallation.md) -- [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md) +- [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/perform-upgrade.md) ### Reference @@ -28,7 +29,7 @@ ### Known issues -- [Known issues](known-issues.md) +- [Known issues](../docs/known-issues.md) ### Features From e4ef184adec2703821c95f14e15aaed73dfdb49b Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 14 Jun 2024 15:14:43 +0200 Subject: [PATCH 3/5] More link fixes, in the table and for Using the cluster. --- content/releases/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 76bd55b8..41ee7039 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -13,7 +13,7 @@ - Get Started with MKE 4 - [Prerequisites](../docs/setup/getting-started/prerequisites.md) - [Create a cluster](../docs/setup/getting-started/create-a-cluster.md) - - [Using the cluster](../docs/setup/getting-started/using-the-cluster.md) + - [Using the cluster](../docs/setup/getting-started/Using-the-cluster.md) - [nstall MKE 4 CLI](../docs/setup/getting-started/install-mke4-cli.md) - [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md) - [Uninstallation](../docs/setup/getting-started/uninstallation.md) @@ -49,12 +49,12 @@ addition, where applicable, the table offers links to associated documentation. | gMSA | | | | GPU Feature Discovery | | | | [Ingress](../docs/reference/ingress/ingress-controller.md) | alpha.1| MVP | | -| [Kubernetes](../docs/concepts/architecture/README.md#Components) | alpha.1 | MVP 1.29 | | +| [Kubernetes](../docs/concepts/architecture.md#Components) | alpha.1 | MVP 1.29 | | | Life Cycle Management | | | | Licensing | | | | Load Balancing | | | | Logging, Monitoring and Alerting | alpha.1 | MVP | -| [Networking (CNI)](../docs/concepts/architecture/README.md#CNI) | alpha.1 | MVP | +| [Networking (CNI)](../docs/concepts/architecture.md#CNI) | alpha.1 | MVP | | Node Feature Discovery | | | | Offline Bundle | | | | OpsCare | | | From 1457b49a710c06b9975999b27d940f6fff2d9757 Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 14 Jun 2024 15:17:33 +0200 Subject: [PATCH 4/5] Addition of architecture folder reference to bad links. --- content/releases/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 41ee7039..8e942957 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -49,12 +49,12 @@ addition, where applicable, the table offers links to associated documentation. | gMSA | | | | GPU Feature Discovery | | | | [Ingress](../docs/reference/ingress/ingress-controller.md) | alpha.1| MVP | | -| [Kubernetes](../docs/concepts/architecture.md#Components) | alpha.1 | MVP 1.29 | | +| [Kubernetes](../docs/concepts/architecture/architecture.md#Components) | alpha.1 | MVP 1.29 | | | Life Cycle Management | | | | Licensing | | | | Load Balancing | | | | Logging, Monitoring and Alerting | alpha.1 | MVP | -| [Networking (CNI)](../docs/concepts/architecture.md#CNI) | alpha.1 | MVP | +| [Networking (CNI)](../docs/concepts/architecture/architecture.md#CNI) | alpha.1 | MVP | | Node Feature Discovery | | | | Offline Bundle | | | | OpsCare | | | From 52bc558d3ff17690215736699d6f0ab8f5be176b Mon Sep 17 00:00:00 2001 From: KoryKessel-Mirantis Date: Fri, 14 Jun 2024 15:23:13 +0200 Subject: [PATCH 5/5] Corrections to link name and character capitalization. --- content/releases/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/releases/README.md b/content/releases/README.md index 8e942957..2eaa5ac7 100644 --- a/content/releases/README.md +++ b/content/releases/README.md @@ -49,12 +49,12 @@ addition, where applicable, the table offers links to associated documentation. | gMSA | | | | GPU Feature Discovery | | | | [Ingress](../docs/reference/ingress/ingress-controller.md) | alpha.1| MVP | | -| [Kubernetes](../docs/concepts/architecture/architecture.md#Components) | alpha.1 | MVP 1.29 | | +| [Kubernetes](../docs/concepts/architecture/architecture.md#components) | alpha.1 | MVP 1.29 | | | Life Cycle Management | | | | Licensing | | | | Load Balancing | | | | Logging, Monitoring and Alerting | alpha.1 | MVP | -| [Networking (CNI)](../docs/concepts/architecture/architecture.md#CNI) | alpha.1 | MVP | +| [Networking (CNI)](../docs/concepts/architecture/architecture.md#container-network-interface) | alpha.1 | MVP | | Node Feature Discovery | | | | Offline Bundle | | | | OpsCare | | |