You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2015/01/28 03:57:34 UTC
[jira] [Commented] (NIFI-280) Machine generate
Processor/ReportingTask/Html documentation
[ https://issues.apache.org/jira/browse/NIFI-280?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14294630#comment-14294630 ]
ASF GitHub Bot commented on NIFI-280:
-------------------------------------
GitHub user danbress opened a pull request:
https://github.com/apache/incubator-nifi/pull/13
Nifi 280
Pull request to resolve NIFI-280
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/danbress/incubator-nifi NIFI-280
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-nifi/pull/13.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #13
----
commit 12ba0ca218f6c6b470ec161ccf6edb079a38e660
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T15:09:58Z
NIFI-280 - Setting up HTML documentation writers
commit 64e5fa71619bf3ea7de06927baffb29115bfcccc
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T15:48:55Z
NIFI-280 - Incorporating documentation generation into framework
commit 78e880d78d1bdcbe79064676418989785a506d82
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T16:06:49Z
NIFI-280 cleaning up documentation
commit 5b03898410837d14b10f72dc7d7c48868a97d16e
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T17:41:27Z
NIFI-280 updating included Processors/ControllerServices/ReportingTasks docs
commit f9a8b5e61d82d8108a397a0520f5c94cd980a79b
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T18:10:46Z
NIFI-280 updating existing documentation
commit 35edc9edd8ab6e1a4eb8bc939335c68cb303f138
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:14:47Z
NIFI-280 continuing to update existing processor documentation
commit 64f235b023d98e4f0f2cd5cbfa822324f40895e1
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:28:17Z
NIFI-280
cleaning up generated html
commit 3a30634821eeed76bf5452cd5ecf1cf856536c96
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:41:22Z
NIFI-280
cleaning up generated HTML
commit a1e6fc01d9af257f27de949f11b01b57d27e0542
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:57:20Z
NIFI-280
Applying ASF License to files
commit a488a721f7d2f270f0bda50e4b99968b8ea9d704
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T15:35:34Z
NIFI-280
Writing Javadoc
commit afcf14fbd41634d56452a237f5bd88c0e13767ae
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T15:44:34Z
NIFI-280
using commons-lang3 instead of commons-lang
commit a753e004ce4ee21a8634735c5af15b82482dd138
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T16:43:04Z
NIFI-280
Buffering output, cleaning up pom
commit c8158c8cc81d5e22d132ad5522ea7119943ab250
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T15:09:58Z
NIFI-280 - Setting up HTML documentation writers
commit 8ff1c2ab819236cd8fc0718c554a08913dfb8db7
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T15:48:55Z
NIFI-280 - Incorporating documentation generation into framework
commit 2732835883319029d1507b50b663c0d790b76623
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T16:06:49Z
NIFI-280 cleaning up documentation
commit 44be06b9c219d963d9a9cae33033ea5bfed7195b
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T17:41:27Z
NIFI-280 updating included Processors/ControllerServices/ReportingTasks docs
commit 6982aa5259bc0e68cfa38df7e1ead7a9ba41e206
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-24T18:10:46Z
NIFI-280 updating existing documentation
commit 9fa0eeeef8295e070b1e2db1d69497947c9d1b03
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:14:47Z
NIFI-280 continuing to update existing processor documentation
commit 189edb8b69275f46188eb4b0247dd1e44fb29b74
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:28:17Z
NIFI-280
cleaning up generated html
commit a410fd084d7d0c0dd964a7c4748d397e16a442d1
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:41:22Z
NIFI-280
cleaning up generated HTML
commit 0f0210592b5c122124c6e91a8a1f65a1e4482252
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T14:57:20Z
NIFI-280
Applying ASF License to files
commit d8a65b066dfd5be2542490f8bd905fccc8e05707
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T15:35:34Z
NIFI-280
Writing Javadoc
commit d8caa8774b2556ba05b181d4277abad36bd75da4
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T15:44:34Z
NIFI-280
using commons-lang3 instead of commons-lang
commit 07477aa5fc41b7f03a7151849325d777485cda70
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-25T16:43:04Z
NIFI-280
Buffering output, cleaning up pom
commit ce9aa48998b2f6626f92ef1fb3f09b18748c2fec
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-28T01:11:22Z
NIFI-280
Using latest annotations
commit 2841bc85a20d4a4dde90658241bf88d813f34a5e
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-28T01:55:15Z
NIFI-280
improving unit tests
commit f6b8f304ca1584cb7792b097f6b4917d07042a30
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-28T02:01:45Z
NIFI-280
formatting generated HTML a little better.
Using displayName instead of value
commit 1d2a7bf01e58507f83bb05cd6f9c5aef50d757b3
Author: danbress <db...@onyxconsults.com>
Date: 2015-01-28T02:12:10Z
Merge branch 'NIFI-280' of https://github.com/danbress/incubator-nifi into NIFI-280
Conflicts:
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedControllerService.java
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedReportingTask.java
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/html/HtmlDocumentationWriterTest.java
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/html/ProcessorDocumentationWriterTest.java
----
> Machine generate Processor/ReportingTask/Html documentation
> -----------------------------------------------------------
>
> Key: NIFI-280
> URL: https://issues.apache.org/jira/browse/NIFI-280
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Core Framework, Core UI, Documentation & Website
> Affects Versions: 0.0.1
> Reporter: Dan Bress
> Priority: Minor
> Fix For: 0.1.0
>
> Original Estimate: 96h
> Remaining Estimate: 96h
>
> The goals of this effort will be:
> - Machine generate as much of the basic(processor description, property description, relationship description) info as possible. This
> will make the developers lives better by storing this information in one
> place, and make users lives better by having the "inline" documentation
> match the "usage" documentation. This will also ensure that all the
> documentation is formatted consistently.
> - Allow the developer to optionally provide additional html and
> images that would be linked from the machine generated documentation
> - Provide a way for the documentation to be generated statically
> and linked from the Apache NiFi webpage
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)