Build artifacts used for Website

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Build artifacts used for Website

Dan Bress
It looks like there are a few documentation artifacts that are currently being manually copied out of the build and put on the website.  Can we configure maven to help with this?  Such that after a build is made, we have a collection of files, without having to cherry pick, that could be uploaded to the website so it reflects what's in a release.  I'm thinking maybe looking into mvn site to do this.  I tried this out today and it took 45 minutes to build the site... Hopefully that can be made shorter with proper configuration.


Currently I see this happening for these files:

 - NiFi Overview

 - NiFi User Guide


I'd like to see this also for:

 - Administrator Guide

 - Developer Guide

 - Expression Language Guide

 - Processor/ControllerService/ReportingTask Documentation

 - Javadoc


What do you think?  Would this be helpful?  I'm wrapping up my documentation task(NIFI-280) and was trying to think about how to best generate this information for the website, when I realized we have a few other documents that come out of the build and go on the website.


Dan Bress
Software Engineer
ONYX Consulting Services
Reply | Threaded
Open this post in threaded view
|

Re: Build artifacts used for Website

Matt Gilman
Dan,

Your right, currently we have been just manually copying those documents
over. Aldrin and I are working on an updated website right now. Let us try
to get a handle on how that's going to get put together to see how we can
best automate this process because the manual copying isn't good. How we
handle this will likely depend on what repository the website will live in
(separate or existing beside nifi and nifi-nar-maven-plug) and how the
website is built and deployed. Hopefully, we can have some answers to this
shortly.

Matt



On Sun, Jan 25, 2015 at 5:13 PM, Daniel Bress <[hidden email]>
wrote:

> It looks like there are a few documentation artifacts that are currently
> being manually copied out of the build and put on the website.  Can we
> configure maven to help with this?  Such that after a build is made, we
> have a collection of files, without having to cherry pick, that could be
> uploaded to the website so it reflects what's in a release.  I'm thinking
> maybe looking into mvn site to do this.  I tried this out today and it took
> 45 minutes to build the site... Hopefully that can be made shorter with
> proper configuration.
>
>
> Currently I see this happening for these files:
>
>  - NiFi Overview
>
>  - NiFi User Guide
>
>
> I'd like to see this also for:
>
>  - Administrator Guide
>
>  - Developer Guide
>
>  - Expression Language Guide
>
>  - Processor/ControllerService/ReportingTask Documentation
>
>  - Javadoc
>
>
> What do you think?  Would this be helpful?  I'm wrapping up my
> documentation task(NIFI-280) and was trying to think about how to best
> generate this information for the website, when I realized we have a few
> other documents that come out of the build and go on the website.
>
>
> Dan Bress
> Software Engineer
> ONYX Consulting Services
>
Reply | Threaded
Open this post in threaded view
|

Re: Build artifacts used for Website

Dan Bress
Matt,
   Good to know/glad I asked.  I'll sit tight and work with what you guys come up with.  I'm hoping to initiate a pull request for the component generation in the framework in the next day or two.

Thanks,
Dan

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Matt Gilman <[hidden email]>
Sent: Sunday, January 25, 2015 5:21 PM
To: [hidden email]
Subject: Re: Build artifacts used for Website

Dan,

Your right, currently we have been just manually copying those documents
over. Aldrin and I are working on an updated website right now. Let us try
to get a handle on how that's going to get put together to see how we can
best automate this process because the manual copying isn't good. How we
handle this will likely depend on what repository the website will live in
(separate or existing beside nifi and nifi-nar-maven-plug) and how the
website is built and deployed. Hopefully, we can have some answers to this
shortly.

Matt



On Sun, Jan 25, 2015 at 5:13 PM, Daniel Bress <[hidden email]>
wrote:

> It looks like there are a few documentation artifacts that are currently
> being manually copied out of the build and put on the website.  Can we
> configure maven to help with this?  Such that after a build is made, we
> have a collection of files, without having to cherry pick, that could be
> uploaded to the website so it reflects what's in a release.  I'm thinking
> maybe looking into mvn site to do this.  I tried this out today and it took
> 45 minutes to build the site... Hopefully that can be made shorter with
> proper configuration.
>
>
> Currently I see this happening for these files:
>
>  - NiFi Overview
>
>  - NiFi User Guide
>
>
> I'd like to see this also for:
>
>  - Administrator Guide
>
>  - Developer Guide
>
>  - Expression Language Guide
>
>  - Processor/ControllerService/ReportingTask Documentation
>
>  - Javadoc
>
>
> What do you think?  Would this be helpful?  I'm wrapping up my
> documentation task(NIFI-280) and was trying to think about how to best
> generate this information for the website, when I realized we have a few
> other documents that come out of the build and go on the website.
>
>
> Dan Bress
> Software Engineer
> ONYX Consulting Services
>
Reply | Threaded
Open this post in threaded view
|

Re: Build artifacts used for Website

Matt Gilman
Dan,

Sorry this is taking so long. Still trying to go a hold on CMing the site
artifacts and figuring out the deployment side of things. Anyways, I'm
imagining the site will just reference the documents generated during the
NiFi build via an agreed upon location. I think we can (as I believe you
were suggesting) automate the deployment of these artifacts (guides,
javadocs, etc) during the build/release process using something like...

http://maven.apache.org/plugins/maven-scm-publish-plugin/

Matt

On Mon, Jan 26, 2015 at 9:14 AM, Daniel Bress <[hidden email]>
wrote:

> Matt,
>    Good to know/glad I asked.  I'll sit tight and work with what you guys
> come up with.  I'm hoping to initiate a pull request for the component
> generation in the framework in the next day or two.
>
> Thanks,
> Dan
>
> Dan Bress
> Software Engineer
> ONYX Consulting Services
>
> ________________________________________
> From: Matt Gilman <[hidden email]>
> Sent: Sunday, January 25, 2015 5:21 PM
> To: [hidden email]
> Subject: Re: Build artifacts used for Website
>
> Dan,
>
> Your right, currently we have been just manually copying those documents
> over. Aldrin and I are working on an updated website right now. Let us try
> to get a handle on how that's going to get put together to see how we can
> best automate this process because the manual copying isn't good. How we
> handle this will likely depend on what repository the website will live in
> (separate or existing beside nifi and nifi-nar-maven-plug) and how the
> website is built and deployed. Hopefully, we can have some answers to this
> shortly.
>
> Matt
>
>
>
> On Sun, Jan 25, 2015 at 5:13 PM, Daniel Bress <[hidden email]>
> wrote:
>
> > It looks like there are a few documentation artifacts that are currently
> > being manually copied out of the build and put on the website.  Can we
> > configure maven to help with this?  Such that after a build is made, we
> > have a collection of files, without having to cherry pick, that could be
> > uploaded to the website so it reflects what's in a release.  I'm thinking
> > maybe looking into mvn site to do this.  I tried this out today and it
> took
> > 45 minutes to build the site... Hopefully that can be made shorter with
> > proper configuration.
> >
> >
> > Currently I see this happening for these files:
> >
> >  - NiFi Overview
> >
> >  - NiFi User Guide
> >
> >
> > I'd like to see this also for:
> >
> >  - Administrator Guide
> >
> >  - Developer Guide
> >
> >  - Expression Language Guide
> >
> >  - Processor/ControllerService/ReportingTask Documentation
> >
> >  - Javadoc
> >
> >
> > What do you think?  Would this be helpful?  I'm wrapping up my
> > documentation task(NIFI-280) and was trying to think about how to best
> > generate this information for the website, when I realized we have a few
> > other documents that come out of the build and go on the website.
> >
> >
> > Dan Bress
> > Software Engineer
> > ONYX Consulting Services
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Build artifacts used for Website

Dan Bress
Matt,
   No rush, you're not holding me up at all.

   Your plan with the agreed upon location, and the scm plugin sounds good to me.  I haven't put a ton of thought into how to tie my stuff into the build.  I'll look at that next.

Thanks,

Dan Bress
Software Engineer
ONYX Consulting Services

________________________________________
From: Matt Gilman <[hidden email]>
Sent: Thursday, January 29, 2015 8:16 PM
To: [hidden email]
Subject: Re: Build artifacts used for Website

Dan,

Sorry this is taking so long. Still trying to go a hold on CMing the site
artifacts and figuring out the deployment side of things. Anyways, I'm
imagining the site will just reference the documents generated during the
NiFi build via an agreed upon location. I think we can (as I believe you
were suggesting) automate the deployment of these artifacts (guides,
javadocs, etc) during the build/release process using something like...

http://maven.apache.org/plugins/maven-scm-publish-plugin/

Matt

On Mon, Jan 26, 2015 at 9:14 AM, Daniel Bress <[hidden email]>
wrote:

> Matt,
>    Good to know/glad I asked.  I'll sit tight and work with what you guys
> come up with.  I'm hoping to initiate a pull request for the component
> generation in the framework in the next day or two.
>
> Thanks,
> Dan
>
> Dan Bress
> Software Engineer
> ONYX Consulting Services
>
> ________________________________________
> From: Matt Gilman <[hidden email]>
> Sent: Sunday, January 25, 2015 5:21 PM
> To: [hidden email]
> Subject: Re: Build artifacts used for Website
>
> Dan,
>
> Your right, currently we have been just manually copying those documents
> over. Aldrin and I are working on an updated website right now. Let us try
> to get a handle on how that's going to get put together to see how we can
> best automate this process because the manual copying isn't good. How we
> handle this will likely depend on what repository the website will live in
> (separate or existing beside nifi and nifi-nar-maven-plug) and how the
> website is built and deployed. Hopefully, we can have some answers to this
> shortly.
>
> Matt
>
>
>
> On Sun, Jan 25, 2015 at 5:13 PM, Daniel Bress <[hidden email]>
> wrote:
>
> > It looks like there are a few documentation artifacts that are currently
> > being manually copied out of the build and put on the website.  Can we
> > configure maven to help with this?  Such that after a build is made, we
> > have a collection of files, without having to cherry pick, that could be
> > uploaded to the website so it reflects what's in a release.  I'm thinking
> > maybe looking into mvn site to do this.  I tried this out today and it
> took
> > 45 minutes to build the site... Hopefully that can be made shorter with
> > proper configuration.
> >
> >
> > Currently I see this happening for these files:
> >
> >  - NiFi Overview
> >
> >  - NiFi User Guide
> >
> >
> > I'd like to see this also for:
> >
> >  - Administrator Guide
> >
> >  - Developer Guide
> >
> >  - Expression Language Guide
> >
> >  - Processor/ControllerService/ReportingTask Documentation
> >
> >  - Javadoc
> >
> >
> > What do you think?  Would this be helpful?  I'm wrapping up my
> > documentation task(NIFI-280) and was trying to think about how to best
> > generate this information for the website, when I realized we have a few
> > other documents that come out of the build and go on the website.
> >
> >
> > Dan Bress
> > Software Engineer
> > ONYX Consulting Services
> >
>