Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit readme breadcrumbs for TOC purposes #31

Closed
wants to merge 8 commits into from
Closed

Edit readme breadcrumbs for TOC purposes #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f3b7bf2
Initial edit of MKE 4 supportbundle content, including text changes a…
KoryKessel-Mirantis May 31, 2024
797bc07
Edits made in response to review by Magda Dziadosz.
KoryKessel-Mirantis Jun 7, 2024
9ae1c7c
Edit to include a note directive for step one of collect host informa…
KoryKessel-Mirantis Jun 7, 2024
d4c351e
Fixed non-working Note directive inserted with previous commit.
KoryKessel-Mirantis Jun 7, 2024
331568a
Initial edit of README.md, to transform it into a TOC for docs content.
KoryKessel-Mirantis Jun 7, 2024
a96c1df
Delete content/docs/reference/supportbundle/support-bundle.md
KoryKessel-Mirantis Jun 7, 2024
526c913
Edit in response to RyanZ comments. Addition of links to TOC entries.
KoryKessel-Mirantis Jun 7, 2024
069e3b2
Change filename of installation.md to create-a-cluster.md and correct…
KoryKessel-Mirantis Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions content/docs/reference/supportbundle/README.md
View file
Open in desktop

This file was deleted.

34 changes: 28 additions & 6 deletions content/releases/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,52 @@

## MKE 4

### Concepts and Architecture

- [Architecture](../docs/concepts/architecture/architecture.md)

Check failure on line 7 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L7 

Connot reach ../docs/concepts/architecture/architecture.md. Status: 404 Cannot find: ../docs/concepts/architecture/architecture.md
Raw output 
message:"Connot reach ../docs/concepts/architecture/architecture.md. Status: 404 Cannot find: ../docs/concepts/architecture/architecture.md"  location:{path:"content/releases/README.md"  range:{start:{line:7  column:3}  end:{line:7  column:64}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [Configuration](../docs/concepts/architecture/configuration.md)
- [Migrate configuration](../docs/concepts/architecture/migrate-configuration.md)

Check failure on line 9 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L9 

Connot reach ../docs/concepts/architecture/migrate-configuration.md. Status: 404 Cannot find: ../docs/concepts/architecture/migrate-configuration.md
Raw output 
message:"Connot reach ../docs/concepts/architecture/migrate-configuration.md. Status: 404 Cannot find: ../docs/concepts/architecture/migrate-configuration.md"  location:{path:"content/releases/README.md"  range:{start:{line:9  column:3}  end:{line:9  column:82}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}

### Setup
[Install mkectl](../docs/setup/README.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still need it for https://github.com/Mirantis/mke-docs/blob/main/content/docs/setup/README.md


[Get Started with MKE 4](../docs/setup/getting-started/README.md)
- [Get Started with MKE 4](../docs/setup/getting-started/README.md)
- [Prerequisites](../docs/setup/getting-started/prerequisites.md)

Check failure on line 14 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L14 

Connot reach ../docs/setup/getting-started/prerequisites.md. Status: 404 Cannot find: ../docs/setup/getting-started/prerequisites.md
Raw output 
message:"Connot reach ../docs/setup/getting-started/prerequisites.md. Status: 404 Cannot find: ../docs/setup/getting-started/prerequisites.md"  location:{path:"content/releases/README.md"  range:{start:{line:14  column:5}  end:{line:14  column:68}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [Create a cluster](../docs/setup/getting-started/create-a-cluster.md)

Check failure on line 15 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L15 

Connot reach ../docs/setup/getting-started/create-a-cluster.md. Status: 404 Cannot find: ../docs/setup/getting-started/create-a-cluster.md
Raw output 
message:"Connot reach ../docs/setup/getting-started/create-a-cluster.md. Status: 404 Cannot find: ../docs/setup/getting-started/create-a-cluster.md"  location:{path:"content/releases/README.md"  range:{start:{line:15  column:5}  end:{line:15  column:74}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [Using the cluster](../docs/setup/getting-started/using-the-cluster.md)

Check failure on line 16 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L16 

Connot reach ../docs/setup/getting-started/using-the-cluster.md. Status: 404 Cannot find: ../docs/setup/getting-started/using-the-cluster.md
Raw output 
message:"Connot reach ../docs/setup/getting-started/using-the-cluster.md. Status: 404 Cannot find: ../docs/setup/getting-started/using-the-cluster.md"  location:{path:"content/releases/README.md"  range:{start:{line:16  column:5}  end:{line:16  column:76}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [k0s in AWS](../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md)

Check failure on line 17 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L17 

Connot reach ../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md. Status: 404 Cannot find: ../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md
Raw output 
message:"Connot reach ../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md. Status: 404 Cannot find: ../docs/setup/getting-started/k0s-in-aws/terraform-scenario.md"  location:{path:"content/releases/README.md"  range:{start:{line:17  column:5}  end:{line:17  column:81}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [Uninstallation](../docs/setup/getting-started/uninstallation.md)

Check failure on line 18 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L18 

Connot reach ../docs/setup/getting-started/uninstallation.md. Status: 404 Cannot find: ../docs/setup/getting-started/uninstallation.md
Raw output 
message:"Connot reach ../docs/setup/getting-started/uninstallation.md. Status: 404 Cannot find: ../docs/setup/getting-started/uninstallation.md"  location:{path:"content/releases/README.md"  range:{start:{line:18  column:5}  end:{line:18  column:70}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md)

### Reference

- [Authentication](../docs/reference/authentication/authentication.md)

Check failure on line 23 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L23 

Connot reach ../docs/reference/authentication/authentication.md. Status: 404 Cannot find: ../docs/reference/authentication/authentication.md
Raw output 
message:"Connot reach ../docs/reference/authentication/authentication.md. Status: 404 Cannot find: ../docs/reference/authentication/authentication.md"  location:{path:"content/releases/README.md"  range:{start:{line:23  column:3}  end:{line:23  column:71}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}
- [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/README.md)
### Known issues

- [Known issues](known-issues.md)

Check failure on line 31 in content/releases/README.md

View workflow job for this annotation

GitHub Actions / Linkspector

[linkspector] content/releases/README.md#L31 

Connot reach known-issues.md. Status: 404 Cannot find: known-issues.md
Raw output 
message:"Connot reach known-issues.md. Status: 404 Cannot find: known-issues.md"  location:{path:"content/releases/README.md"  range:{start:{line:31  column:3}  end:{line:31  column:34}}}  severity:ERROR  source:{name:"linkspector"  url:"https://github.com/UmbrellaDocs/linkspector"}

### 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 | alpha.1| MVP |
| Authorization | alpha.1 | MVP |
| [Backup & Restore](../docs/reference/backuprestore/README.md) | alpha.1 | MVP |
| [Backup and restore](../docs/reference/backuprestore/backup-restore.md) | alpha.1 | MVP |
| CIS Benchmark | | |
| CLI | | |
| Cloud Providers | | |
| CoreDNS | | |
| cAdvisor | | |
| gMSA | | |
| GPU Feature Discovery | | |
| [Ingress](../docs/reference/ingress/README.md) | alpha.1| MVP | |
| [Ingress](../docs/reference/ingress/ingress-controller.md) | alpha.1| MVP | |
| [Kubernetes](../docs/concepts/architecture/README.md#Components) | alpha.1 | MVP 1.29 | |
| Life Cycle Management | | |
| Licensing | | |
Expand Down
Loading