rfellows commented on code in PR #8693: URL: https://github.com/apache/nifi/pull/8693#discussion_r1576421090
########## nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-frontend/src/main/nifi/README.md: ########## @@ -1,41 +1,73 @@ # NiFi -<a alt="Nx logo" href="https://nx.dev"; target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png"; width="45"></a> - ## General Info -### Nx - -If you are unfamiliar Nx, you can learn more at https://nx.dev/getting-started/intro. They provide many solid resources to get you up to speed. - -_From Nx:_ - -> We created Nx because developers struggle to configure, maintain and especially integrate various tools and frameworks. -> Setting up a system that works well for a handful of developers and at the same time, easily scales up to an entire organization is hard. -> This includes setting up low-level build tooling, configuring fast CI, and keeping your codebase healthy, up-to-date, and maintainable. +This module is the primary UI for NiFi. It contains the canvas and all UI's for managing the NiFi instance. There are other modules within the codebase +that support other UIs that intergate with this. These include documentation, data viewers, advanced configuration UIs, error handling, and Registry UIs. +Overtime, these will all be modernized and possibly brought into this Nx repo to co-locate all the front end code. + +In its current state it is not quite ready to replace the existing UI as there are a few features that are not implemented yet. The new UI will not +be available with the default build. However, if the build activates the `include-new-ui` profile the new UI will be built and included. On startup, +NiFi has been updated to locate the new UI and if present deploy it to a new context path (`/nf`). If the new UI is not found, nothing is deployed to +the new context path and the application functions as it does today. + +One thing to note, when using the new UI running in NiFi at `/nf`, the user can log in and use the application. When logging out however, there is +a hardcoded redirect that happens from the back end which sends the user to the old UI (`/nifi`). + +Once the remaining features have been implemented, the look and feel has be polished, and it is ready for release the old UI will be removed, update +the context path for the new UI to use `/nifi`, and remove the `include-new-ui` Maven profile. At that point, the logout redirection issue called out above won’t +be a problem anymore. + +## Source Structure + +The structure of the application is laid out in the following manner. + +- app + - pages + - flow-designer + - feature + - service + - state + - ui + - settings + - feature + - service + - state + - ui + - ... + - service + - state + - ui Review Comment: ```suggestion app ├── pages │ ├── flow-designer │ │ ├── feature │ │ ├── service │ │ ├── state │ │ └── ui │ ├── settings │ │ ├── feature │ │ ├── service │ │ ├── state │ │ └── ui ├── service ├── state └── ui ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@nifi.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
![https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png"](https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png"){kind=link}