Skip to content

Commit

Permalink
Added a step or two
Browse files Browse the repository at this point in the history
  • Loading branch information
suprjinx committed Aug 22, 2023
1 parent afc918b commit 9f8cbda
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ make build
FasttrackML incorporates the existing Aim and MLFlow web UIs, albeit
with a few modifications. This is accomplished at build time by
importing the `fasttrackml-ui-aim` and `fasttrackml-ui-mlflow`
modules. These repos contain patched and compiled ui assets of the upstream
repos. To make a UI change, a PR is merged to the appropriate
release branch and new tag is pushed. At that point, the `fasttrackml`
reference can be updated (in go.mod) to the new tag.
modules. These repos contain the patched and compiled UI assets of the
upstream repos at specific tagged revisions. To make a UI change, a PR
is merged to the appropriate release branch and new tag is pushed. At
that point, the `fasttrackml` reference can be updated (in go.mod) to
pull in the new tag.

For UI development, you'll need a tighter change/view loop,
so we recommend the following approach.
Expand Down Expand Up @@ -70,3 +71,8 @@ your UI working copy.
cd ../fasttrackml
go run main.go server --listen-address ":5000"
```
7. You should now be able to see your local working copy of the UI at
`localhost:5000`. As you make changes in the UI's `/src` folder,
re-run the compile step.
8. When ready, make a PR of your changes for the UI repo, with the
merge target set as the release branch

0 comments on commit 9f8cbda

Please sign in to comment.