From da9d55d22f84b2678c44d8b0597bc3957f845903 Mon Sep 17 00:00:00 2001 From: Ben Carver Date: Thu, 29 Feb 2024 17:10:40 -0500 Subject: [PATCH] Updated README. --- README.md | 47 +++++------------------------------------------ 1 file changed, 5 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 57a0f4c8..7fb34f68 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ -# Patternfly Seed +# Distributed Notebook Cluster: Workload Driver -Patternfly Seed is an open source build scaffolding utility for web apps. The primary purpose of this project is to give developers a jump start when creating new projects that will use patternfly. A secondary purpose of this project is to serve as a reference for how to configure various aspects of an application that uses patternfly, webpack, react, typescript, etc. +This repository contains a "Workload Driver" for the Distributed Jupyter Notebook Cluster (which is not yet open-sourced). -Out of the box you'll get an app layout with chrome (header/sidebar), routing, build pipeline, test suite, and some code quality tools. Basically, all the essentials. - -Out of box dashboard view of patternfly seed +The Workload Driver provides a web interface containing a dashboard for monitoring the Notebook Cluster. The Workload Driver will also allow users to execute large-scale workloads on the Jupyter Notebook cluster. ## Quick-start ```bash -git clone https://github.com/patternfly/patternfly-react-seed -cd patternfly-react-seed +git clone https://github.com/Scusemua/workload-driver-react +cd workload-driver-react npm install && npm run start:dev ``` ## Development scripts @@ -55,41 +53,6 @@ npm run build:storybook * [Jest Config](./jest.config.js) * [Editor Config](./.editorconfig) -## Raster image support - -To use an image asset that's shipped with PatternFly core, you'll prefix the paths with "@assets". `@assets` is an alias for the PatternFly assets directory in node_modules. - -For example: -```js -import imgSrc from '@assets/images/g_sizing.png'; -Some image -``` - -You can use a similar technique to import assets from your local app, just prefix the paths with "@app". `@app` is an alias for the main src/app directory. - -```js -import loader from '@app/assets/images/loader.gif'; -Content loading -``` - -## Vector image support -Inlining SVG in the app's markup is also possible. - -```js -import logo from '@app/assets/images/logo.svg'; - -``` - -You can also use SVG when applying background images with CSS. To do this, your SVG's must live under a `bgimages` directory (this directory name is configurable in [webpack.common.js](./webpack.common.js#L5)). This is necessary because you may need to use SVG's in several other context (inline images, fonts, icons, etc.) and so we need to be able to differentiate between these usages so the appropriate loader is invoked. -```css -body { - background: url(./assets/bgimages/img_avatar.svg); -} -``` - -## Adding custom CSS -When importing CSS from a third-party package for the first time, you may encounter the error `Module parse failed: Unexpected token... You may need an appropriate loader to handle this file typ...`. You need to register the path to the stylesheet directory in [stylePaths.js](./stylePaths.js). We specify these explicitly for performance reasons to avoid webpack needing to crawl through the entire node_modules directory when parsing CSS modules. - ## Code quality tools * For accessibility compliance, we use [react-axe](https://github.com/dequelabs/react-axe) * To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)