Script to update the docs table by rafvasq · Pull Request #317 · claimed-framework/mlx

rafvasq · 2022-03-18T00:34:47Z

Addresses #316

Script goes into each doc and takes its first line (assumed to be a descriptive header) as a description for the documentation overview table in the /docs/ README.

It's possible that this PR makes #314 no longer needed.

FYI @ckadner

ckadner

Great! Thanks @rafvasq -- I merged your other PR and merged the changes into this PR

I have only a few small nit-picks

docs/README.md

tools/python/update_doc_table.py

ckadner

Hi Rafal,

please change your script to use relative links instead of linking to the MLX Github repo?

Otherwise looks good.

docs/README.md

tools/python/update_doc_table.py

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

ckadner

Thanks @rafvasq -- we need a little more cleanup after removing the GitHub repo links :-)

tools/python/update_doc_table.py

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

rafvasq · 2022-03-30T19:43:54Z

Thanks for the reviews @ckadner, going keep a better eye out to catch theses smaller changes next time. :)

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

ckadner

Thanks Rafael. Looks good! :-)

mlx-bot · 2022-03-30T20:17:05Z

[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

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [ckadner]

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

ckadner · 2022-03-30T20:23:03Z

/lgtm

* Add dev doc links to CONTRIBUTING.md (#312) Resolves a task from #304 Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> * Fixes the references to latest kfctl release (#311) Resolves a task from #304 Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> * Do not verify links in project dependencies (#320) Resolves #319 Signed-off-by: Christian Kadner <ckadner@us.ibm.com> * 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 <rafael.vasquez@ryerson.com> * Add script to update the docs table (#317) Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> * 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 <krishnakumar@ibm.com> * 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] <support@github.com> 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] <support@github.com> 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] <support@github.com> 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] <support@github.com> 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 <psspavan96@gmail.com> Co-authored-by: Christian Kadner <ckadner@us.ibm.com> * Update UI developer docs (#323) Closes #323 Signed-off-by: RRM123 <rithikmamidi@gmail.com> * Correct description for make update_doc_table (#329) Signed-off-by: ezinneanne <onwukaezinneanne@gmail.com> * 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 <kiran.patel@ibm.com> Signed-off-by: Kiran Patel 104844270+kiranp2396@users.noreply.github.com Signed-off-by: Christian Kadner <ckadner@us.ibm.com> Co-authored-by: Kiran-Patel <kiran.patel@ibm.com> Co-authored-by: Christian Kadner <ckadner@us.ibm.com> * fix errors in mlx-ui startup (#338) * Run mlx-ui as non-root user (#339) Closes #337 Signed-off-by: Christian Kadner <ckadner@us.ibm.com> * Update MLX setup instructions for KF 1.5 (#346) * Update MLX setup instructions for KF 1.5 Signed-off-by: Christian Kadner <ckadner@us.ibm.com> * fix selected assets show up in different menus (#342) Signed-off-by: Jiaxuan-Yang <jiaxuan.yang@ibm.com> * Consolidate readme (#356) Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.com> * Document MLX Models Workshop (#352) Signed-off-by: Christian Kadner <ckadner@us.ibm.com> * Add GitHub action to verify doc links (#357) Signed-off-by: Rafael Vasquez <raf.vasquez@ibm.com> Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com> Signed-off-by: Christian Kadner <ckadner@us.ibm.com> Signed-off-by: Krishna Kumar <krishnakumar@ibm.com> Signed-off-by: RRM123 <rithikmamidi@gmail.com> Signed-off-by: ezinneanne <onwukaezinneanne@gmail.com> Signed-off-by: Jiaxuan-Yang <jiaxuan.yang@ibm.com> Signed-off-by: Rafael Vasquez <raf.vasquez@ibm.com> Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.ca> Co-authored-by: Krishna Kumar Ramachandran <krishnakumar@gatech.edu> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Pavan Pss <psspavan96@gmail.com> Co-authored-by: RRM123 <40575227+rrm123@users.noreply.github.com> Co-authored-by: Ezinne Anne Emilia <onwukaezinneanne@gmail.com> Co-authored-by: Kiran Patel <104844270+kiranp2396@users.noreply.github.com> Co-authored-by: Kiran-Patel <kiran.patel@ibm.com> Co-authored-by: jbusche <101845348+jbusche@users.noreply.github.com> Co-authored-by: Joanna <Jiaxuan.Yang@ibm.com> Co-authored-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

mlx-bot requested review from Tomcli and ckadner March 18, 2022 00:34

rafvasq changed the title ~~Added a script that can update the docs table~~ Script to update the docs table Mar 18, 2022

ckadner mentioned this pull request Mar 18, 2022

Do not verify links in project dependencies #320

Merged

rafvasq mentioned this pull request Mar 18, 2022

Add navigation and description table of docs #314

Merged

ckadner suggested changes Mar 18, 2022

View reviewed changes

rafvasq force-pushed the new_tool branch from e0d82bc to bdde255 Compare March 19, 2022 00:22

rafvasq requested a review from ckadner March 19, 2022 15:02

rafvasq force-pushed the new_tool branch 3 times, most recently from 4db70ab to 9559b44 Compare March 23, 2022 19:50

ckadner suggested changes Mar 30, 2022

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

docs/README.md Outdated Show resolved Hide resolved

tools/python/update_doc_table.py Outdated Show resolved Hide resolved

Rafael Vasquez and others added 3 commits March 30, 2022 11:55

Add script to update doc table

1470d21

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

Correct HTML comment

19d9c1f

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

Use relative links

523e087

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

rafvasq force-pushed the new_tool branch from 1709e39 to 523e087 Compare March 30, 2022 15:55

rafvasq requested a review from ckadner March 30, 2022 15:55

ckadner suggested changes Mar 30, 2022

View reviewed changes

tools/python/update_doc_table.py Outdated Show resolved Hide resolved

tools/python/update_doc_table.py Outdated Show resolved Hide resolved

tools/python/update_doc_table.py Outdated Show resolved Hide resolved

tools/python/update_doc_table.py Show resolved Hide resolved

Lint and add description

ac41d06

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

rafvasq requested a review from ckadner March 30, 2022 19:42

Format function

baeb0cd

Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>

ckadner approved these changes Mar 30, 2022

View reviewed changes

mlx-bot added the approved label Mar 30, 2022

Merge branch 'main' into new_tool

1752e22

ckadner approved these changes Mar 30, 2022

View reviewed changes

ckadner merged commit e3bfcc7 into claimed-framework:main Mar 30, 2022

rafvasq deleted the new_tool branch April 4, 2022 17:48

ckadner mentioned this pull request Apr 22, 2022

Make target update_doc_table has incorrect description #328

Closed

ckadner added the Jump-Start Work items for Jump-Start participants label Jun 2, 2022

Conversation

rafvasq commented Mar 18, 2022

Uh oh!

ckadner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ckadner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ckadner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rafvasq commented Mar 30, 2022

Uh oh!

ckadner left a comment

Choose a reason for hiding this comment

Uh oh!

mlx-bot commented Mar 30, 2022

Uh oh!

ckadner commented Mar 30, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants