Re: [DISCUSS] Docs from non packaged NARs
This makes me wonder how documentation is going to work with the registry, should the documentation show all the nars that are in the registry and available or all the cars local? etc. From: Pierre Villard Reply: dev@nifi.apache.org Date: November 9, 2021 at 18:17:30 To: dev@nifi.apache.org Subject: [DISCUSS] Docs from non packaged NARs Hi team, I'd like to discuss the possibility to change the release process we have for the next releases so that the documentation of all components we have in the repository are published as part of the release process. All of the documentation for components that are in specific profiles are not only skipped for the final convenience binary but also for the documentation. We have a tremendous amount of great components in this "by default excluded" NARs and it would be helpful to have the corresponding documentation to at least redirect users when we get some questions on the users mailing list. I feel like this should only be a release process thing but I could be wrong. Something that could be even better would be to enable all the profiles by default but only for nifi-docs module? Not sure if that is even a possibility. Thoughts? Thanks, Pierre
Re: [DISCUSS] Docs from non packaged NARs
Sorry sent that in a rush. I think this could be done pretty easily by the RM. If you have a script that pulls all nars and ensures they end up in the convenience binary we use to grab the docs from (but not the convenience binary we actually ship). If anyone is up for making such a script that would be very helpful. Thanks On Tue, Nov 9, 2021 at 5:59 PM Joe Witt wrote: > I could pretty easily do this if I have a list of all nars. Probably > easily scripted > > thanks > > On Tue, Nov 9, 2021 at 4:56 PM Matt Burgess wrote: > >> 100% agree, didn't give any thought on how to do it but definitely on >> board :) We show users where to find these NARs when they ask (or >> there are some links around), and if you add the NAR(s) the docs show >> up in your NiFi instance, but to really showcase the power of NiFi we >> should publicly display all the docs for all the components published >> as a result of a release. >> >> Regards, >> Matt >> >> On Tue, Nov 9, 2021 at 6:17 PM Pierre Villard >> wrote: >> > >> > Hi team, >> > >> > I'd like to discuss the possibility to change the release process we >> have >> > for the next releases so that the documentation of all components we >> have >> > in the repository are published as part of the release process. >> > >> > All of the documentation for components that are in specific profiles >> are >> > not only skipped for the final convenience binary but also for the >> > documentation. We have a tremendous amount of great components in this >> "by >> > default excluded" NARs and it would be helpful to have the corresponding >> > documentation to at least redirect users when we get some questions on >> the >> > users mailing list. >> > >> > I feel like this should only be a release process thing but I could be >> > wrong. >> > >> > Something that could be even better would be to enable all the profiles >> by >> > default but only for nifi-docs module? Not sure if that is even a >> > possibility. >> > >> > Thoughts? >> > >> > Thanks, >> > Pierre >> >
Re: [DISCUSS] Docs from non packaged NARs
I could pretty easily do this if I have a list of all nars. Probably easily scripted thanks On Tue, Nov 9, 2021 at 4:56 PM Matt Burgess wrote: > 100% agree, didn't give any thought on how to do it but definitely on > board :) We show users where to find these NARs when they ask (or > there are some links around), and if you add the NAR(s) the docs show > up in your NiFi instance, but to really showcase the power of NiFi we > should publicly display all the docs for all the components published > as a result of a release. > > Regards, > Matt > > On Tue, Nov 9, 2021 at 6:17 PM Pierre Villard > wrote: > > > > Hi team, > > > > I'd like to discuss the possibility to change the release process we have > > for the next releases so that the documentation of all components we have > > in the repository are published as part of the release process. > > > > All of the documentation for components that are in specific profiles are > > not only skipped for the final convenience binary but also for the > > documentation. We have a tremendous amount of great components in this > "by > > default excluded" NARs and it would be helpful to have the corresponding > > documentation to at least redirect users when we get some questions on > the > > users mailing list. > > > > I feel like this should only be a release process thing but I could be > > wrong. > > > > Something that could be even better would be to enable all the profiles > by > > default but only for nifi-docs module? Not sure if that is even a > > possibility. > > > > Thoughts? > > > > Thanks, > > Pierre >
Re: [DISCUSS] Docs from non packaged NARs
100% agree, didn't give any thought on how to do it but definitely on board :) We show users where to find these NARs when they ask (or there are some links around), and if you add the NAR(s) the docs show up in your NiFi instance, but to really showcase the power of NiFi we should publicly display all the docs for all the components published as a result of a release. Regards, Matt On Tue, Nov 9, 2021 at 6:17 PM Pierre Villard wrote: > > Hi team, > > I'd like to discuss the possibility to change the release process we have > for the next releases so that the documentation of all components we have > in the repository are published as part of the release process. > > All of the documentation for components that are in specific profiles are > not only skipped for the final convenience binary but also for the > documentation. We have a tremendous amount of great components in this "by > default excluded" NARs and it would be helpful to have the corresponding > documentation to at least redirect users when we get some questions on the > users mailing list. > > I feel like this should only be a release process thing but I could be > wrong. > > Something that could be even better would be to enable all the profiles by > default but only for nifi-docs module? Not sure if that is even a > possibility. > > Thoughts? > > Thanks, > Pierre
