Consolidate UI developer docs (#258) #323

RRM123 · 2022-03-29T01:48:58Z

Deleted portion of developer-guide.md that was functionally the same as the dashboard/origin-mlx/README.md. Replaced with pointer to dashboard/origin-mlx/README.md.
Included information about how to start the UI using an existing docker image or local code (via npm start).
Included a pointer to dashboard/origin-mlx/developer-guide.md for Development Guidlines.
Removed outdated OLD_README.md

Resolves machine-learning-exchange#258 Signed-off-by: RRM123 <rithikmamidi@gmail.com>

mlx-bot · 2022-03-29T01:49:01Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: RRM123
To complete the pull request process, please assign ckadner after the PR has been reviewed.
You can assign the PR to them by writing /assign @ckadner in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

RRM123 · 2022-03-29T20:15:58Z

@ckadner Forgot to tag you in this PR

ckadner

Thanks @RRM123 -- this is a good improvement. I would make a few small changes.

ckadner · 2022-03-30T22:25:51Z

dashboard/origin-mlx/README.md


 ## UI Development with Docker Compose
+For information on how to get started with Docker Compose, and it's appropriate setup, check out the 


This is a good bit of information :-) I would change it slightly to:

For information on how to get started with Docker Compose before making any changes to the UI code, check out the Quick Start Guide and take a look at the docker-compose.yaml file to understand how the individual services like mysql, minio, mlx-api, mlx-ui, etc. are working together.

ckadner · 2022-03-30T22:28:16Z

dashboard/origin-mlx/README.md

+For information on how to get started with Docker Compose, and it's appropriate setup, check out the 
+[Quick Start Guide](../../quickstart/README.md).
+
+To bring up the Docker Compose stack run:


I would remove the 2 commands here as they are duplicated from in the Quickstart guide, or, point out how they are different (i.e. using the --project-name ... flag)

ckadner · 2022-03-30T22:29:08Z

dashboard/origin-mlx/README.md

+```Bash
+docker compose --project-name  mlx  down
+```
+To bring up the stack without the UI run:


these 2 commands are described already in context of the next passage

RRM123

Implemented changes outlined in the PR review.

ckadner

Thank you @RRM123 -- this is a good improvement to our UI developer docs. I think we can take it a few steps further even.

ckadner · 2022-04-08T23:27:03Z

dashboard/origin-mlx/README.md

@@ -72,15 +74,29 @@ docker push <your docker user-id>/<repo name>:<tag name>
 ```

 ## (Re-)Deploy to Kubernetes Cluster
+For information on how to deploy MLX on a Kubernetes Cluster or OpenShift on IBM Cloud, check out the guide [here](../../docs/mlx-setup.md).
+Once the clusters have been deployed, they will need to be redeployed for UI work.


this may be slightly misleading. A more precise phrasing would be:

Once the cluster has been deployed, the MLX UI will need to be redeployed after changes to the UI code have been made.

ckadner · 2022-04-08T23:29:12Z

dashboard/origin-mlx/README.md


 Change the Docker image tag in the deployment spec server/mlx-ui.yml from image: ibmandrewbutler/open-ui:add-homepage to image: <your_docker_user_id>/<repo name>:<tag name> and then run:

 ```Bash
 kubectl delete -f ./dashboard/origin-mlx/mlx-ui.yml
 kubectl apply -f ./dashboard/origin-mlx/mlx-ui.yml
 ```
+Change the image in /manifests/base/mlx-deployments/mlx-ui.yaml under the container with the name mlx-ui at spec.template.spec.containers


did you try this out? should this be either or? ... either

./dashboard/origin-mlx/mlx-ui.yml or

/manifests/base/mlx-deployments/mlx-ui.yaml

ckadner · 2022-04-08T23:31:23Z

dashboard/origin-mlx/README.md


 ## UI Development with Docker Compose
+For information on how to get started with Docker Compose before making any changes to the UI code, check out the [Quick Start Guide](../../quickstart/README.md) and take a look at the [docker-compose.yaml](../../quickstart/docker-compose.yaml) file to understand how the individual services like ```mysql```, ```minio```, ```mlx-api```, ```mlx-ui```, etc. are working together.
+
+The Docker Compose stack can be brought up and taken down by running the following commands. The ```--project-name``` tag takes in the following argument as the name of the docker compose stack, which can be viewed using [Docker Desktop](https://www.docker.com/products/docker-desktop/):


single back ticks `` for inline code sections like

The --project-name flag ...

the benefit of using the --project-name flag is to keep the docker compose network and the volumes (stored assets) separate from the quickstart for development. Each docker compose project has separate network and volumes

ckadner · 2022-04-08T23:34:16Z

dashboard/origin-mlx/README.md

@@ -116,7 +132,7 @@ docker compose rm -v -f
 docker volume prune -f
 ```

-### Terminal 2 - Start the UI server
+### Terminal 2 - Start the MLX UI locally with Docker API


there is no Docker involved in this second terminal

ckadner · 2022-04-08T23:35:48Z

dashboard/origin-mlx/README.md

@@ -185,6 +201,9 @@ which matches a previous request and the difference of the time between the two

 To invalidate or hard reset the cache, navigate to the settings page (clicking the three dots at the bottom of the sidebar) and click on the `Reset Cache` button.

+# Development Guidlines:
+For information on UI code structure, design principles, etc. check out the [MLX Developer Guide](developer-guide.md).


"MLX UI Developer Guide" ... the API has a separate one

ckadner · 2022-04-08T23:42:41Z

dashboard/origin-mlx/developer-guide.md

@@ -133,3 +77,5 @@ src/styles/ contains most (>90%) of the page styling in css. If the style needs


 src/lib/api/ contains all of the calls to the MLX API. If some API call is going wrong, it will likely be an issue in this folder.
+
+For more information on UI Development Setup go [here](README.md)


if we have two files

the /dashboard/origin-mlx/README.md and

the /dashboard/origin-mlx/developer-guide.md

then we should make a clear separation of content:

all the parts in the README.md that talk about development should be in the developer-guide,

and the README only has information about how to use (and deploy) the MLX UI

Although the developer guide also needs to inform about how to redeploy the MLX UI. So I am not convinced we need two documents if the README can contain all of it. If we have one README, then it should flow from overview, architecture diagram, how to deploy (point to general deployment docs) to running locally to development with docker compose, rebuild Docker image, push it, redeploy just the new MLX UI image to existing cluster, ...

ckadner · 2022-04-08T23:45:24Z

the DCO check is failing since some commits are missing the Signed-off-by:

@RRM123

Signed-off-by: @RRM123

@RRM123

Signed-off-by: @RRM123

RRM123 · 2022-04-21T01:36:02Z

@ckadner I reworked the wording of the paragraphs in question, and I made sure to add a Signed-off-by to the new commits. How can I add it to the previous commits that are missing it?

ckadner

/lgtm

Thanks Rithik I made a few final updates and merged it directly.

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

RRM123 and others added 4 commits March 28, 2022 21:31

Consolidated UI Developer Docs

e4207d0

Resolves machine-learning-exchange#258 Signed-off-by: RRM123 <rithikmamidi@gmail.com>

Merge branch 'machine-learning-exchange:main' into main

484be2b

Made README.md point to developer-guide.md.

e2c76cd

Resolves machine-learning-exchange#258 Signed-off-by: RRM123 <rithikmamidi@gmail.com>

Merge remote-tracking branch 'origin/main' into main

3feed5b

mlx-bot requested a review from Tomcli March 29, 2022 01:49

mlx-bot requested a review from yhwang March 29, 2022 01:49

ckadner requested review from ckadner and removed request for yhwang and Tomcli March 29, 2022 18:15

ckadner requested changes Mar 30, 2022

View reviewed changes

Update README.md

2cd7708

RRM123 commented Apr 4, 2022

View reviewed changes

ckadner requested changes Apr 8, 2022

View reviewed changes

RRM123 added 2 commits April 20, 2022 21:33

Update README.md

5edd3e8

Signed-off-by: @RRM123

Update developer-guide.md

921536b

Signed-off-by: @RRM123

ckadner closed this in 605fe33 Apr 22, 2022

ckadner reviewed Apr 22, 2022

View reviewed changes

ckadner added the RCOS Potential work items for RCOS student interns label Jun 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consolidate UI developer docs (#258) #323

Consolidate UI developer docs (#258) #323

RRM123 commented Mar 29, 2022

mlx-bot commented Mar 29, 2022

RRM123 commented Mar 29, 2022

ckadner left a comment

ckadner Mar 30, 2022

ckadner Mar 30, 2022

ckadner Mar 30, 2022

RRM123 left a comment

ckadner left a comment

ckadner Apr 8, 2022

ckadner Apr 8, 2022

ckadner Apr 8, 2022

ckadner Apr 8, 2022

ckadner Apr 8, 2022

ckadner Apr 8, 2022

ckadner commented Apr 8, 2022

RRM123 commented Apr 21, 2022

ckadner left a comment •

edited

Loading


		## UI Development with Docker Compose
		For information on how to get started with Docker Compose, and it's appropriate setup, check out the

		@@ -133,3 +77,5 @@ src/styles/ contains most (>90%) of the page styling in css. If the style needs


		src/lib/api/ contains all of the calls to the MLX API. If some API call is going wrong, it will likely be an issue in this folder.

		For more information on UI Development Setup go [here](README.md)

Consolidate UI developer docs (#258) #323

Consolidate UI developer docs (#258) #323

Conversation

RRM123 commented Mar 29, 2022

mlx-bot commented Mar 29, 2022

RRM123 commented Mar 29, 2022

ckadner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RRM123 left a comment

Choose a reason for hiding this comment

ckadner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ckadner commented Apr 8, 2022

RRM123 commented Apr 21, 2022

ckadner left a comment • edited Loading

Choose a reason for hiding this comment

ckadner left a comment •

edited

Loading