Documentation for 1.x

[Mark Bean <ma...@gmail.com>]

I have been asking many questions lately regarding NiFi 1.x because we are
in the process of more deliberately evaluating 1.x as it relates to our
current production level flows. In the process, I have found the
documentation to be incomplete, sometimes incorrect (e.g. typo), contain
references to 0.x-specific items and generally lacking information (e.g.
"In the future, we hope to provide supplemental documentation that covers
the NiFi Cluster Architecture in depth.") IMO, the guides are not always
sufficient to a novice user, but require pre-existing knowledge or
experience to read between the lines.

In general, I think the provided documentation (starting with the Admin and
User Guides) could use a thorough review and update. Is this something that
is on anyone's the "hit list"? If someone picks this up, I could provide
feedback in a more directed way rather than spamming the mailing list.

Thanks,
Mark

Re: Documentation for 1.x

[Mark Bean <ma...@gmail.com>]

Tony,

Per James' suggestion, I created NIFI-3701 to track documentation
enhancement requests. I will update the ticket with more specifics.

Thanks,
Mark


On Wed, Apr 12, 2017 at 12:04 PM, Tony Kurc <tr...@gmail.com> wrote:

> Mark,
> The docs are community developed. The community would be very accepting of
> improvements and fixes. That being said, there is more documentation on how
> to contribute code than there is documentation, and it can depend if it is
> in confluence, the processors, or on the web page. Do you have more
> specifics?
>
> Tony
>
> On Wed, Apr 12, 2017 at 11:54 AM, Mark Bean <ma...@gmail.com> wrote:
>
> > I have been asking many questions lately regarding NiFi 1.x because we
> are
> > in the process of more deliberately evaluating 1.x as it relates to our
> > current production level flows. In the process, I have found the
> > documentation to be incomplete, sometimes incorrect (e.g. typo), contain
> > references to 0.x-specific items and generally lacking information (e.g.
> > "In the future, we hope to provide supplemental documentation that covers
> > the NiFi Cluster Architecture in depth.") IMO, the guides are not always
> > sufficient to a novice user, but require pre-existing knowledge or
> > experience to read between the lines.
> >
> > In general, I think the provided documentation (starting with the Admin
> and
> > User Guides) could use a thorough review and update. Is this something
> that
> > is on anyone's the "hit list"? If someone picks this up, I could provide
> > feedback in a more directed way rather than spamming the mailing list.
> >
> > Thanks,
> > Mark
> >
>

Re: Documentation for 1.x

[Tony Kurc <tr...@gmail.com>]

Mark,
The docs are community developed. The community would be very accepting of
improvements and fixes. That being said, there is more documentation on how
to contribute code than there is documentation, and it can depend if it is
in confluence, the processors, or on the web page. Do you have more
specifics?

Tony

On Wed, Apr 12, 2017 at 11:54 AM, Mark Bean <ma...@gmail.com> wrote:

> I have been asking many questions lately regarding NiFi 1.x because we are
> in the process of more deliberately evaluating 1.x as it relates to our
> current production level flows. In the process, I have found the
> documentation to be incomplete, sometimes incorrect (e.g. typo), contain
> references to 0.x-specific items and generally lacking information (e.g.
> "In the future, we hope to provide supplemental documentation that covers
> the NiFi Cluster Architecture in depth.") IMO, the guides are not always
> sufficient to a novice user, but require pre-existing knowledge or
> experience to read between the lines.
>
> In general, I think the provided documentation (starting with the Admin and
> User Guides) could use a thorough review and update. Is this something that
> is on anyone's the "hit list"? If someone picks this up, I could provide
> feedback in a more directed way rather than spamming the mailing list.
>
> Thanks,
> Mark
>

Re: Documentation for 1.x

[James Wing <jv...@gmail.com>]

Mark,

Would you please open a JIRA ticket for known doc issues and feedback (
https://issues.apache.org/jira/browse/NIFI/)?  I do not know if anyone is
actively doing such a review at this minute, but the documentation is
frequently updated as contributions come in.

By the way, we are always looking for contributors :). Even if you don't
know the specific answers that should go into the documentation, sharing
your experiences of frustration are definitely valuable feedback for
improvements.  A good ticket is a great contribution on its own.

Thanks,

James

On Wed, Apr 12, 2017 at 8:54 AM, Mark Bean <ma...@gmail.com> wrote:

> I have been asking many questions lately regarding NiFi 1.x because we are
> in the process of more deliberately evaluating 1.x as it relates to our
> current production level flows. In the process, I have found the
> documentation to be incomplete, sometimes incorrect (e.g. typo), contain
> references to 0.x-specific items and generally lacking information (e.g.
> "In the future, we hope to provide supplemental documentation that covers
> the NiFi Cluster Architecture in depth.") IMO, the guides are not always
> sufficient to a novice user, but require pre-existing knowledge or
> experience to read between the lines.
>
> In general, I think the provided documentation (starting with the Admin and
> User Guides) could use a thorough review and update. Is this something that
> is on anyone's the "hit list"? If someone picks this up, I could provide
> feedback in a more directed way rather than spamming the mailing list.
>
> Thanks,
> Mark
>