Removing documentation from deployment

[Mike Thomsen <mi...@gmail.com>]

We have a situation where we might need to remove the documentation to
get around some security scans. What would be involved in removing the
whole documentation deployment? I can hack up the assembly descriptor
as much as needed.

Thanks,

Mike

Re: Removing documentation from deployment

[Edward Armes <ed...@gmail.com>]

Just had a thought given that the UI links through in the docs are there
any tests or build conditions that break around the UI packaging if this
was to be done?

Edward

On Tue, Mar 16, 2021 at 10:38 PM Matt Burgess <ma...@apache.org> wrote:

> I haven't tried it, but I would think you could add a profile
> (disabled by default) that would override the nifi-docs dependency
> with a "provided" scope. That should exclude it from the assembly. But
> if you're building RPMs you may need to touch a couple other places.
>
> That should exclude the top-level docs like the Admin Guide and such.
> But AFAIK we generate the component docs as their NARs are loaded into
> NiFi, and the location is specified by the
> nifi.documentation.working.directory property (defaulting to
> ./work/docs/components). Perhaps you could set that to /dev/null or
> some other dead-letter location.
>
> Regards,
> Matt
>
> On Tue, Mar 16, 2021 at 11:56 AM Mike Thomsen <mi...@gmail.com>
> wrote:
> >
> > We have a situation where we might need to remove the documentation to
> > get around some security scans. What would be involved in removing the
> > whole documentation deployment? I can hack up the assembly descriptor
> > as much as needed.
> >
> > Thanks,
> >
> > Mike
>

Re: Removing documentation from deployment

[Matt Burgess <ma...@apache.org>]

I haven't tried it, but I would think you could add a profile
(disabled by default) that would override the nifi-docs dependency
with a "provided" scope. That should exclude it from the assembly. But
if you're building RPMs you may need to touch a couple other places.

That should exclude the top-level docs like the Admin Guide and such.
But AFAIK we generate the component docs as their NARs are loaded into
NiFi, and the location is specified by the
nifi.documentation.working.directory property (defaulting to
./work/docs/components). Perhaps you could set that to /dev/null or
some other dead-letter location.

Regards,
Matt

On Tue, Mar 16, 2021 at 11:56 AM Mike Thomsen <mi...@gmail.com> wrote:
>
> We have a situation where we might need to remove the documentation to
> get around some security scans. What would be involved in removing the
> whole documentation deployment? I can hack up the assembly descriptor
> as much as needed.
>
> Thanks,
>
> Mike