diff --git a/docs/reference/alpha-web-ui.md b/docs/reference/alpha-web-ui.md index 02dd107f1b..e2136536bf 100644 --- a/docs/reference/alpha-web-ui.md +++ b/docs/reference/alpha-web-ui.md @@ -100,7 +100,7 @@ yarn start The advantage of importing Feast UI as a module is in the ease of customization. The `` component exposes a `feastUIConfigs` prop thorough which you can customize the UI. Currently it supports a few parameters. -**Fetching the Project List** +##### Fetching the Project List You can use `projectListPromise` to provide a promise that overrides where the Feast UI fetches the project list from. @@ -118,11 +118,11 @@ You can use `projectListPromise` to provide a promise that overrides where the F /> ``` -**Custom Tabs** +##### Custom Tabs You can add custom tabs for any of the core Feast objects through the `tabsRegistry`. -``` +```jsx const tabsRegistry = { RegularFeatureViewCustomTabs: [ { @@ -141,3 +141,23 @@ const tabsRegistry = { ``` Examples of custom tabs can be found in the `ui/custom-tabs` folder. + +##### Custom Basename + +If you want to serve the UI under a specific URL path instead of at the root, +you can use the `basename` prop, and it will be forwarded to React Router. + +For example, to serve the UI at the `/feast-ui` path: + +```jsx + res.json()) + }} +/> +``` diff --git a/ui/README.md b/ui/README.md index a2326e1a9e..823abdf17a 100644 --- a/ui/README.md +++ b/ui/README.md @@ -97,7 +97,7 @@ You can use `projectListPromise` to provide a promise that overrides where the F You can add custom tabs for any of the core Feast objects through the `tabsRegistry`. -``` +```jsx const tabsRegistry = { RegularFeatureViewCustomTabs: [ { @@ -117,6 +117,26 @@ const tabsRegistry = { Examples of custom tabs can be found in the `/custom-tabs` folder. +##### Custom Basename + +If you want to serve the UI under a specific URL path instead of at the root, +you can use the `basename` prop, and it will be forwarded to React Router. + +For example, to serve the UI at the `/feast-ui` path: + +```jsx + res.json()) + }} +/> +``` + ## 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).