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.

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

Add navigation and description table of docs #314

Merged
merged 5 commits into from
Mar 18, 2022
Merged
Changes from 3 commits
Commits
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
12 changes: 12 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| Documentation | Description |
rafvasq marked this conversation as resolved.
Show resolved Hide resolved
| :----------- | :------------- |
| [import-assets.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/import-assets.md) | Import a catalog of assets to an MLX instance |
rafvasq marked this conversation as resolved.
Show resolved Hide resolved
| [install-mlx-on-kind.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/install-mlx-on-kind.md) | Deploy MLX on [Kubernetes in Docker (KIND)](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) |
| [install-mlx-on-kubeflow.md](install-mlx-on-kubeflow.md) | Deploy MLX on an existing Kubeflow cluster |
| [mlx-install-operator.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/mlx-install-operator.md) | Deploy MLX using [Kubeflow Operator](https://www.kubeflow.org/docs/distributions/operator/introduction/) |
| [mlx-install-with-kubeflow.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/mlx-install-with-kubeflow.md) | Deploy MLX on an existing Kubernetes or OpenShift cluster |
| [mlx-read-only-deployment.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/mlx-read-only-deployment.md) | Deploy MLX in Read-Only Mode on an existing Kubernetes or OpenShift cluster |
| [mlx-setup.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/mlx-setup.md) | Deploy MLX in single-user mode on an existing Kubernetes or OpenShift cluster |
| [mlx-workshop.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/mlx-workshop.md) | MLX Tutorial demonstrating data analysis, model training and deployment on Kubernetes |
| [troubleshooting.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/troubleshooting.md) | Common issues deploying MLX |
| [usage-steps.md](https://github.com/rafvasq/mlx/blob/doc-table/docs/usage-steps.md) | Navigation links to step-by-step usage tutorials |