Skip to content

Add navigation and description table of docs #314

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

Merged
ckadner merged 5 commits into from
Mar 18, 2022
Merged

Add navigation and description table of docs #314

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a62ad91
Create readme for docs
Mar 14, 2022
2064802
Add description table to readme
Mar 14, 2022
1e76732
Add links to table
Mar 14, 2022
185128d
update relative links
Mar 16, 2022
dee6898
Change documentation to document
Mar 18, 2022
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
View file
Open in desktop
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) |
Copy link
Contributor

@ckadner ckadner Mar 18, 2022

Choose a reason for hiding this comment

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

I think the hyperlinks in the Description column might be distracting, leading people away from the actual document we want them to visit. Also might be hard to generate the hyperlink with a script later.

Copy link
Contributor Author

@rafvasq rafvasq Mar 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I agree. Ultimately, the script in #317 doesn't generate hyperlinks for the description since it simply parses the header of the document and uses that as the description.

Is it possible that this PR isn't needed anymore since #317 can add both the table and the script? I imagine it'd be a smoother merge but maybe there's a benefit to doing this one first that I'm not aware of.

| [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 |