Skip to content

docs: Add Web UI documentation on repo structure #3014

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

Merged
feast-ci-bot merged 6 commits into from
Aug 4, 2022
Merged

docs: Add Web UI documentation on repo structure #3014

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8167504
docs: Add Web UI documentation on repo structure
adchia Aug 4, 2022
d3a6fb8
fix
adchia Aug 4, 2022
94ab0fb
update release docs
adchia Aug 4, 2022
0a39454
update release docs
adchia Aug 4, 2022
b0f06db
remove unnecessary step
adchia Aug 4, 2022
f4961bf
fix nits
adchia Aug 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix 
Signed-off-by: Danny Chiao <danny@tecton.ai>
  • Loading branch information
@adchia
adchia committed Aug 4, 2022
commit d3a6fb8a526663beeac1ce2b36f1fc0f6deb5144
2 changes: 1 addition & 1 deletion sdk/python/feast/ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
18 changes: 13 additions & 5 deletions ui/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
<h2>Table of contents</h2>

- [General contributor](#general-contributor)
- [General contributor notes](#general-contributor-notes)
- [`feast ui` command](#feast-ui-command)
- [NPM package project structure](#npm-package-project-structure)
- [Tests](#tests)
- [Yarn commands](#yarn-commands)
- [`yarn install`](#yarn-install)
- [`yarn start`](#yarn-start)
- [`yarn test`](#yarn-test)
- [Release process](#release-process)
- [1) Publishing the Feast Package to NPM](#1-publishing-the-feast-package-to-npm)
- [Publishing the Feast Package to NPM](#publishing-the-feast-package-to-npm)
- [Requirements](#requirements)
- [Steps for Publishing](#steps-for-publishing)
- [2) Linking to the new UI in the Feast Python SDK](#2-linking-to-the-new-ui-in-the-feast-python-sdk)

# General contributor
# General contributor notes
In this doc, we describe how to contribute both to the Feast Web UI NPM package as well as the embedded Feast UI in the Python SDK (i.e. what's run when you run `feast ui`)

## `feast ui` command
You can see the logic in [../sdk/python/ui](../sdk/python/feast/ui/). This instance is loaded in [../sdk/python/ui_server.py](../sdk/python/feast/ui_server.py).
Comment thread
adchia marked this conversation as resolved.
Outdated

Under the hood, what happens is that the Feast SDK spins up a server which exposes an endpoint to the registry. It then mounts the UI on the server and points it to fetch data from that registry.

## NPM package 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.
Expand Down Expand Up @@ -71,9 +77,11 @@ There are a couple of components in Feast that are tied to the Web UI:
1. the npm package
2. the Feast Python SDK, which bundles in a compiled version of the Feast Web UI which is run on a `feast ui` CLI command.

The bundled Web UI in the Python SDK always compiles in the latest npm version, so we only need to ensure the npm package is published correctly

**TODO(adchia): Update Feast's release process to automatically bump versions and publish npm packages as part of semantic release**

## 1) Publishing the Feast Package to NPM
## Publishing the Feast Package to NPM

The Feast UI is published as a module to NPM and can be found here: https://www.npmjs.com/package/@feast-dev/feast-ui

Expand All @@ -92,6 +100,6 @@ To publish a new version of the module, you will need:
5. [Check NPM to see that the package was properly publish](https://www.npmjs.com/package/@feast-dev/feast-ui).

## 2) Linking to the new UI in the Feast Python SDK
You can see the logic in [../sdk/python/ui](../sdk/python/feast/ui/). This instance is loaded in [../sdk/python/ui_server.py](../sdk/python/feast/ui_server.py).


To ensure this gets released in the next Feast SDK patch release, update the `package.json` file in [../sdk/python/ui](../sdk/python/feast/ui/) (specifically bumping the version of @feast-dev/feast-ui to the new version).
2 changes: 1 addition & 1 deletion ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@feast-dev/feast-ui",
"version": "0.20.5",
"version": "0.23.0",
"private": false,
"files": [
"dist"
Expand Down