[DISCUSS] Updated NiFi Flow Design System

[Shane Ardell <sh...@gmail.com>]

Team,

As work continues with the new NiFi UI as well as the Jolt Transform UI, it
has come to my attention that these two interfaces utilize a library of
shared Angular components, directives, pipes, etc., located at
`nifi-frontend/src/main/frontend/libs/shared`. In my opinion, this shared
library seems to be the successor to nifi-fds, which is not utilized by
either of the new interfaces and doesn't seem to be actively maintained. If
others feel the same, I think we should discuss how to move forward with
eventually removing nifi-fds as a dependency and possibly incorporating a
library like Storybook [1] to provide documentation for the new design
system.

The only hurdle I see to removing nifi-fds would be the fact that
nifi-registry still depends on it. In order to resolve this, we would need
to update nifi-registry to the latest version of Angular and refactor the
application to utilize this new shared library.

What does everyone think?

Shane

[1] https://nx.dev/recipes/storybook/overview-angular

Re: [DISCUSS] Updated NiFi Flow Design System

[Matt Gilman <ma...@gmail.com>]

Sounds like a plan.

Thanks Shane!

Matt

On Wed, Aug 28, 2024 at 7:44 PM Shane Ardell <sh...@gmail.com>
wrote:

> Perfect, Matt. Thanks for chiming in. Since what I described aligns with
> the direction you and others had in mind, I'll gladly create some Jiras and
> start the effort to migrate nifi-registry. Once that's done, maybe we can
> revisit the idea of style and component documentation via Storybook or a
> similar library for the shared directory.
>
> Shane
>
> On Wed, Aug 21, 2024 at 12:18 PM Matt Gilman <ma...@gmail.com>
> wrote:
>
> > Shane,
> >
> > Thanks for the note. This was exactly what I had in mind as we were
> > unpacking all the changes needed to migrate the various UIs within the
> > repo. Co-locating all of our UIs within the nifi-frontend module gives us
> > the opportunity to share and reuse various components, etc. Further, it
> > gives us a single place for managing all front end dependencies. In time,
> > all UIs will be migrated and updated such that they are on common and
> > current versions of dependencies. I am currently in the process of
> > migrating our content viewers into nifi-frontend following this model.
> >
> > Matt
> >
> > On Wed, Aug 21, 2024 at 10:59 AM Shane Ardell <sh...@gmail.com>
> > wrote:
> >
> > > Team,
> > >
> > > As work continues with the new NiFi UI as well as the Jolt Transform
> UI,
> > it
> > > has come to my attention that these two interfaces utilize a library of
> > > shared Angular components, directives, pipes, etc., located at
> > > `nifi-frontend/src/main/frontend/libs/shared`. In my opinion, this
> shared
> > > library seems to be the successor to nifi-fds, which is not utilized by
> > > either of the new interfaces and doesn't seem to be actively
> maintained.
> > If
> > > others feel the same, I think we should discuss how to move forward
> with
> > > eventually removing nifi-fds as a dependency and possibly
> incorporating a
> > > library like Storybook [1] to provide documentation for the new design
> > > system.
> > >
> > > The only hurdle I see to removing nifi-fds would be the fact that
> > > nifi-registry still depends on it. In order to resolve this, we would
> > need
> > > to update nifi-registry to the latest version of Angular and refactor
> the
> > > application to utilize this new shared library.
> > >
> > > What does everyone think?
> > >
> > > Shane
> > >
> > > [1] https://nx.dev/recipes/storybook/overview-angular
> > >
> >
>

Re: [DISCUSS] Updated NiFi Flow Design System

[Shane Ardell <sh...@gmail.com>]

Perfect, Matt. Thanks for chiming in. Since what I described aligns with
the direction you and others had in mind, I'll gladly create some Jiras and
start the effort to migrate nifi-registry. Once that's done, maybe we can
revisit the idea of style and component documentation via Storybook or a
similar library for the shared directory.

Shane

On Wed, Aug 21, 2024 at 12:18 PM Matt Gilman <ma...@gmail.com>
wrote:

> Shane,
>
> Thanks for the note. This was exactly what I had in mind as we were
> unpacking all the changes needed to migrate the various UIs within the
> repo. Co-locating all of our UIs within the nifi-frontend module gives us
> the opportunity to share and reuse various components, etc. Further, it
> gives us a single place for managing all front end dependencies. In time,
> all UIs will be migrated and updated such that they are on common and
> current versions of dependencies. I am currently in the process of
> migrating our content viewers into nifi-frontend following this model.
>
> Matt
>
> On Wed, Aug 21, 2024 at 10:59 AM Shane Ardell <sh...@gmail.com>
> wrote:
>
> > Team,
> >
> > As work continues with the new NiFi UI as well as the Jolt Transform UI,
> it
> > has come to my attention that these two interfaces utilize a library of
> > shared Angular components, directives, pipes, etc., located at
> > `nifi-frontend/src/main/frontend/libs/shared`. In my opinion, this shared
> > library seems to be the successor to nifi-fds, which is not utilized by
> > either of the new interfaces and doesn't seem to be actively maintained.
> If
> > others feel the same, I think we should discuss how to move forward with
> > eventually removing nifi-fds as a dependency and possibly incorporating a
> > library like Storybook [1] to provide documentation for the new design
> > system.
> >
> > The only hurdle I see to removing nifi-fds would be the fact that
> > nifi-registry still depends on it. In order to resolve this, we would
> need
> > to update nifi-registry to the latest version of Angular and refactor the
> > application to utilize this new shared library.
> >
> > What does everyone think?
> >
> > Shane
> >
> > [1] https://nx.dev/recipes/storybook/overview-angular
> >
>

Re: [DISCUSS] Updated NiFi Flow Design System

[Matt Gilman <ma...@gmail.com>]

Shane,

Thanks for the note. This was exactly what I had in mind as we were
unpacking all the changes needed to migrate the various UIs within the
repo. Co-locating all of our UIs within the nifi-frontend module gives us
the opportunity to share and reuse various components, etc. Further, it
gives us a single place for managing all front end dependencies. In time,
all UIs will be migrated and updated such that they are on common and
current versions of dependencies. I am currently in the process of
migrating our content viewers into nifi-frontend following this model.

Matt

On Wed, Aug 21, 2024 at 10:59 AM Shane Ardell <sh...@gmail.com>
wrote:

> Team,
>
> As work continues with the new NiFi UI as well as the Jolt Transform UI, it
> has come to my attention that these two interfaces utilize a library of
> shared Angular components, directives, pipes, etc., located at
> `nifi-frontend/src/main/frontend/libs/shared`. In my opinion, this shared
> library seems to be the successor to nifi-fds, which is not utilized by
> either of the new interfaces and doesn't seem to be actively maintained. If
> others feel the same, I think we should discuss how to move forward with
> eventually removing nifi-fds as a dependency and possibly incorporating a
> library like Storybook [1] to provide documentation for the new design
> system.
>
> The only hurdle I see to removing nifi-fds would be the fact that
> nifi-registry still depends on it. In order to resolve this, we would need
> to update nifi-registry to the latest version of Angular and refactor the
> application to utilize this new shared library.
>
> What does everyone think?
>
> Shane
>
> [1] https://nx.dev/recipes/storybook/overview-angular
>