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

Script to update the docs table #317

Merged
merged 6 commits into from
Mar 30, 2022
Merged

Script to update the docs table #317

merged 6 commits into from
Mar 30, 2022

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Mar 18, 2022

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

@mlx-bot mlx-bot requested review from ckadner and Tomcli March 18, 2022 00:34
@rafvasq rafvasq changed the title Added a script that can update the docs table Script to update the docs table Mar 18, 2022
@ckadner ckadner mentioned this pull request Mar 18, 2022
Merged
@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.

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 Show resolved Hide resolved
tools/python/update_doc_table.py 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 Outdated Show resolved Hide resolved
tools/python/update_doc_table.py Show resolved Hide resolved
@rafvasq rafvasq requested a review from ckadner March 19, 2022 15:02
@rafvasq rafvasq force-pushed the new_tool branch 3 times, most recently from 4db70ab to 9559b44 Compare March 23, 2022 19:50
ckadner
ckadner requested changes Mar 30, 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.

Hi Rafal,

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

Otherwise looks good.

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>
@ckadner
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 rafvasq requested a review from ckadner March 30, 2022 15:55
ckadner
ckadner requested changes Mar 30, 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 -- we need a little more cleanup after removing the GitHub repo links :-)

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 rafvasq requested a review from ckadner March 30, 2022 19:42
@rafvasq
Copy link
Contributor Author

rafvasq commented Mar 30, 2022

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

Format function
baeb0cd 
Signed-off-by: Rafael Vasquez <rafael.vasquez@ryerson.com>
ckadner
ckadner approved these changes Mar 30, 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. Looks good! :-)

@mlx-bot
Copy link
Collaborator

mlx-bot commented Mar 30, 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 e3bfcc7 into machine-learning-exchange:main Mar 30, 2022
@ckadner
Copy link
Member

ckadner commented Mar 30, 2022

/lgtm

@rafvasq rafvasq deleted the new_tool branch April 4, 2022 17:48
@ckadner ckadner mentioned this pull request Apr 22, 2022
Closed
@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 <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>
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

@Tomcli Tomcli Awaiting requested review from Tomcli

Assignees
No one assigned
Labels
approved Jump-Start Work items for Jump-Start participants
Projects
None yet
Milestone
No milestone
Development

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