Skip to content

Commit

Permalink
Add navigation and description table of docs (#314)
Browse files Browse the repository at this point in the history
* Create readme for docs
* Add description table to readme
* Add links to table
* update relative links
* Change documentation to document

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>
  • Loading branch information
rafvasq authored Mar 18, 2022
1 parent 07377ff commit e26ce79
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| Document | Description |
| :----------- | :------------- |
| [import-assets.md](./import-assets.md) | Import a catalog of assets to an MLX instance |
| [install-mlx-on-kind.md](./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](./mlx-install-operator.md) | Deploy MLX using [Kubeflow Operator](https://www.kubeflow.org/docs/distributions/operator/introduction/) |
| [mlx-install-with-kubeflow.md](./mlx-install-with-kubeflow.md) | Deploy MLX on an existing Kubernetes or OpenShift cluster |
| [mlx-read-only-deployment.md](./mlx-read-only-deployment.md) | Deploy MLX in Read-Only Mode on an existing Kubernetes or OpenShift cluster |
| [mlx-setup.md](./mlx-setup.md) | Deploy MLX in single-user mode on an existing Kubernetes or OpenShift cluster |
| [mlx-workshop.md](./mlx-workshop.md) | MLX Tutorial demonstrating data analysis, model training and deployment on Kubernetes |
| [troubleshooting.md](./troubleshooting.md) | Common issues deploying MLX |
| [usage-steps.md](./usage-steps.md) | Navigation links to step-by-step usage tutorials |

0 comments on commit e26ce79

Please sign in to comment.