docs: Add Web UI documentation on repo structure (#3014)

adchia · adchia · commit fe32c61c9c4d · 2022-08-10T13:17:54.000-04:00
* docs: Add Web UI documentation on repo structure

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;

* fix

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;

* update release docs

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;

* update release docs

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;

* remove unnecessary step

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;

* fix nits

Signed-off-by: Danny Chiao &lt;danny@tecton.ai&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -198,6 +198,8 @@ The services with containerized replacements currently implemented are:
 
 You can run `make test-python-integration-container` to run tests against the containerized versions of dependencies.
 
+## Feast UI
+See [Feast contributing guide](ui/CONTRIBUTING.md)
 
 ## Feast Java Serving
 See [Java contributing guide](java/CONTRIBUTING.md)
diff --git a/sdk/python/feast/ui/package.json b/sdk/python/feast/ui/package.json
@@ -6,7 +6,7 @@
     "@elastic/datemath": "^5.0.3",
     "@elastic/eui": "^57.0.0",
     "@emotion/react": "^11.9.0",
-    "@feast-dev/feast-ui": "^0.20.5",
+    "@feast-dev/feast-ui": "latest",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.2.0",
     "@testing-library/user-event": "^13.5.0",
diff --git a/ui/PUBLISHING_TO_NPM.md b/ui/PUBLISHING_TO_NPM.md
diff --git a/ui/README.md b/ui/README.md
@@ -4,22 +4,10 @@
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-## Project structure
-The Web UI is powered by a JSON registry dump from Feast (running `feast registry-dump`). Running `yarn start` launches a UI
-powered by test data. 
-- `public/` contains assets as well as demo data loaded by the Web UI.
-  - There is a `projects-list.json` which represents all Feast projects the UI shows. 
-  - There is also a `registry.json` which is the registry dump for the feature repo.
-- `feature_repo/` contains a sample Feast repo which generates the `registry.json`
-- `src/` contains the Web UI source code. This parses the registry json blob in  `src/parsers` to make this data 
-available for the rest of the UI.
-- `src/custom-tabs` includes sample custom tabs. This is a WIP plugin system where users can inject their own tabs and 
-data to the UI.
-
 ## Usage
 
 There are three modes of usage: 
-- via the 'feast ui' CLI to view the current feature repository
+- via the `feast ui` CLI to view the current feature repository
 - importing the UI as a module
 - running the entire build as a React app.
 
@@ -124,28 +112,6 @@ const tabsRegistry = {
 
 Examples of custom tabs can be found in the `/custom-tabs` folder.
 
-### Alternative: Run this Repo
-
-If you would like to simply try things out and see how the UI works, you can simply run the code in this repo. First:
-
-### `yarn install` 
-
-That will install the all the dependencies that the UI needs, as well as development dependencies. Then in the project directory, you can run:
-
-### `yarn start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-
 ## On React and Create React App
 
 This project was bootstrapped with Create React App, and uses its scripts to simplify UI development. You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
diff --git a/ui/package.json b/ui/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@feast-dev/feast-ui",
-  "version": "0.20.5",
+  "version": "0.23.0",
   "private": false,
   "files": [
     "dist"

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@feast-dev/feast-ui",`
`3`		`- "version": "0.20.5",`
	`3`	`+ "version": "0.23.0",`
`4`	`4`	`"private": false,`
`5`	`5`	`"files": [`
`6`	`6`	`"dist"`