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

Jump to bottom

Add navigation and description table of docs #314

Merged
merged 5 commits into from
Mar 18, 2022
Merged

Add navigation and description table of docs #314

merged 5 commits into from
Mar 18, 2022

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Mar 14, 2022

Task from #304

Adds a table outlining the files found in the Docs directory with a short description.

FYI @ckadner

Rafael Vasquez added 3 commits March 14, 2022 12:25
Create readme for docs
a62ad91 
Signed-off-by: Rafael Vasquez <[email protected]>
Add description table to readme
2064802 
Signed-off-by: Rafael Vasquez <[email protected]>
Add links to table
1e76732 
Signed-off-by: Rafael Vasquez <[email protected]>
@ckadner ckadner requested review from ckadner and removed request for animeshsingh and Tomcli March 16, 2022 17:28
ckadner
ckadner requested changes Mar 16, 2022
View reviewed changes
Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

Thanks Rafael. We need to update the doc to use relative links

docs/README.md Outdated Show resolved Hide resolved
@ckadner ckadner self-assigned this Mar 16, 2022
@ckadner ckadner added documentation Improvements or additions to documentation do-not-merge/work-in-progress labels Mar 16, 2022
update relative links
185128d 
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq mentioned this pull request Mar 16, 2022
Closed
@rafvasq rafvasq requested a review from ckadner March 16, 2022 20:28
@rafvasq rafvasq mentioned this pull request Mar 18, 2022
Merged
ckadner
ckadner requested changes Mar 18, 2022
View reviewed changes
Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

Thanks @rafvasq -- I have just a few nit-picks :-)

docs/README.md Outdated Show resolved Hide resolved
docs/README.md
| Documentation | 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
Member

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.

@ckadner ckadner mentioned this pull request Mar 18, 2022
Merged
Change documentation to document
dee6898 
Signed-off-by: Rafael Vasquez <[email protected]>
ckadner
ckadner approved these changes Mar 18, 2022
View reviewed changes
Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

/lgtm

@mlx-bot mlx-bot added the lgtm label Mar 18, 2022
@mlx-bot
Copy link
Collaborator

mlx-bot commented Mar 18, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ckadner, rafvasq

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ckadner ckadner merged commit e26ce79 into machine-learning-exchange:main Mar 18, 2022
rafvasq added a commit to rafvasq/mlx that referenced this pull request Mar 23, 2022
@rafvasq
Add navigation and description table of docs (machine-learning-exchan…
c433e4b 
…ge#314)

* 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 <[email protected]>
krishnakumar27 pushed a commit to krishnakumar27/mlx that referenced this pull request Mar 30, 2022
@rafvasq @krishnakumar27
Add navigation and description table of docs (machine-learning-exchan…
ae0d0de 
…ge#314)

* 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 <[email protected]>
Signed-off-by: Krishna Kumar <[email protected]>
@ckadner ckadner added the Jump-Start Work items for Jump-Start participants label Jun 2, 2022
mlx-bot-app bot pushed a commit that referenced this pull request Oct 28, 2022
@ckadner @rafvasq
@krishnakumar27 @dependabot @shanmukha1996 @RRM123 @ezinneanne @kiranp2396 @jbusche @JiaxuanYang
Update v0.2.0 branch (#365)
d304ccc 
* Add dev doc links to CONTRIBUTING.md (#312)

Resolves a task from #304

Signed-off-by: Rafael Vasquez <[email protected]>

* Fixes the references to latest kfctl release (#311)

Resolves a task from #304

Signed-off-by: Rafael Vasquez <[email protected]>

* Do not verify links in project dependencies (#320)

Resolves #319

Signed-off-by: Christian Kadner <[email protected]>

* Add navigation and description table of docs (#314)

* 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 <[email protected]>

* Add script to update the docs table  (#317)


Signed-off-by: Rafael Vasquez <[email protected]>

* Modified the way sed version is set (#315)

Instead of checking the operating system or shell emulator,
test which version of `sed` is actually installed in the local
environment.

Resolves #301

Signed-off-by: Krishna Kumar <[email protected]>

* Bump waitress from 2.0.0 to 2.1.1 in /api/server (#321)

Bumps [waitress](https://github.com/Pylons/waitress) from 2.0.0 to 2.1.1.
- [Release notes](https://github.com/Pylons/waitress/releases)
- [Changelog](https://github.com/Pylons/waitress/blob/master/CHANGES.txt)
- [Commits](Pylons/waitress@v2.0.0...v2.1.1)

---
updated-dependencies:
- dependency-name: waitress
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump jupyter-server from 1.13.4 to 1.15.4 in /api/server (#324)

Bumps [jupyter-server](https://github.com/jupyter/jupyter_server) from 1.13.4 to 1.15.4.
- [Release notes](https://github.com/jupyter/jupyter_server/releases)
- [Changelog](https://github.com/jupyter-server/jupyter_server/blob/main/CHANGELOG.md)
- [Commits](jupyter-server/jupyter_server@v1.13.4...v1.15.4)

---
updated-dependencies:
- dependency-name: jupyter-server
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump minimist from 1.2.5 to 1.2.6 in /dashboard/origin-mlx (#326)

Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump notebook from 6.4.8 to 6.4.10 in /api/server (#327)

Bumps [notebook](http://jupyter.org) from 6.4.8 to 6.4.10.

---
updated-dependencies:
- dependency-name: notebook
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update API developer docs (#325)

* Add codegen workflow diagram
* Describe codegen workflow
* Describe API server package modules

Closes #325

Signed-off-by: Pavan Pss <[email protected]>

Co-authored-by: Christian Kadner <[email protected]>

* Update UI developer docs (#323)

Closes #323

Signed-off-by: RRM123 <[email protected]>

* Correct description for make update_doc_table (#329)

Signed-off-by: ezinneanne <[email protected]>

* Update Kubernetes high version in deployment docs (#318) (#332)

* Add Troubleshooting section
* Limit K8s version for KIND cluster using `--image` flag

Resolves #318

Signed-off-by: Kiran-Patel <[email protected]>
Signed-off-by: Kiran Patel [email protected]
Signed-off-by: Christian Kadner <[email protected]>

Co-authored-by: Kiran-Patel <[email protected]>
Co-authored-by: Christian Kadner <[email protected]>

* fix errors in mlx-ui startup (#338)

* Run mlx-ui as non-root user (#339)

Closes #337

Signed-off-by: Christian Kadner <[email protected]>

* Update MLX setup instructions for KF 1.5 (#346)

* Update MLX setup instructions for KF 1.5

Signed-off-by: Christian Kadner <[email protected]>

* fix selected assets show up in different menus (#342)

Signed-off-by: Jiaxuan-Yang <[email protected]>

* Consolidate readme (#356)

Signed-off-by: Rafael Vasquez <[email protected]>

Signed-off-by: Rafael Vasquez <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>

* Document MLX Models Workshop (#352)

Signed-off-by: Christian Kadner <[email protected]>

* Add GitHub action to verify doc links (#357)

Signed-off-by: Rafael Vasquez <[email protected]>

Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Christian Kadner <[email protected]>
Signed-off-by: Krishna Kumar <[email protected]>
Signed-off-by: RRM123 <[email protected]>
Signed-off-by: ezinneanne <[email protected]>
Signed-off-by: Jiaxuan-Yang <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Co-authored-by: Krishna Kumar Ramachandran <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Pavan Pss <[email protected]>
Co-authored-by: RRM123 <[email protected]>
Co-authored-by: Ezinne Anne Emilia <[email protected]>
Co-authored-by: Kiran Patel <[email protected]>
Co-authored-by: Kiran-Patel <[email protected]>
Co-authored-by: jbusche <[email protected]>
Co-authored-by: Joanna <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ckadner ckadner ckadner approved these changes

Assignees

@ckadner ckadner

Labels
approved do-not-merge/work-in-progress documentation Improvements or additions to documentation Jump-Start Work items for Jump-Start participants lgtm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rafvasq @mlx-bot @ckadner