nifi-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (Jira)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-7319) Provide prescriptive documentation for common tasks
Date Sat, 11 Apr 2020 05:27:01 GMT

    [ https://issues.apache.org/jira/browse/NIFI-7319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17081148#comment-17081148
] 

ASF subversion and git services commented on NIFI-7319:
-------------------------------------------------------

Commit 07a8311b4cedfc1b45ccc8e1a11324bcd3c71da7 in nifi's branch refs/heads/master from Andy
LoPresto
[ https://gitbox.apache.org/repos/asf?p=nifi.git;h=07a8311 ]

NIFI-7319 Add walkthrough document (#4193)

* NIFI-7319 Added first draft of walkthroughs doc.

* NIFI-7319 Added instructions and screenshots for securing standalone NiFi instance.

* NIFI-7319 Added instructions and screenshots for instructing OS & browser to trust self-signed
certificate.

* NIFI-7319 Added instructions and screenshots for securing NiFi with externally-provided
certificates.

* NIFI-7319 Added instructions and screenshots for building NiFi from source.

* NIFI-7319 [WIP] Converting secure cluster instructions to match format.
Fixed instructions regarding embedded ZooKeeper configuration.

* NIFI-7319 Completed secure cluster walkthrough.

* NIFI-7319 Added walkthroughs to documentation navigation list.

* NIFI-7319 Incorporated PR feedback on broken links.

* NIFI-7319 Removed line number helpers from update sections.

* NIFI-7319 Incorporated final PR review items.

Co-authored-by: Sandra Pius <spiusapache@gmail.com>

> Provide prescriptive documentation for common tasks
> ---------------------------------------------------
>
>                 Key: NIFI-7319
>                 URL: https://issues.apache.org/jira/browse/NIFI-7319
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation &amp; Website
>    Affects Versions: 1.11.4
>            Reporter: Andy LoPresto
>            Assignee: Andy LoPresto
>            Priority: Major
>              Labels: community, configuration, documentation, flow_design, prescriptive_docs,
security
>          Time Spent: 9.5h
>  Remaining Estimate: 0h
>
> There are a number of common tasks which community members frequently have trouble understanding
and performing. Assisting users with these tasks requires a high level of knowledge, dedicated
time and effort, and is often 1:1 rather than scalable. 
> Existing NiFi documentation is descriptive (i.e. a compendium of reference material)
but rarely _prescriptive_ (i.e. step-by-step guides to performing these tasks). I propose
adding another document which collects these walkthrough instructions for representative tasks.

> Each section should include:
> * A brief description of the scenario
> * A brief description of why a user would undertake this action
> * A baseline starting point to ensure consistency
> * The expected outcome after completing these steps
> * Possible errors encountered or common mistakes called out
> * Detailed sequential actions to take
> ** Exact terminal commands or UI/API actions to take
> ** An explanation of each step
> ** Screenshots when possible
> ** Output/expected result for each step
> Example topics:
> # Configuring TLS for a standalone NiFi instance
> # Configuring TLS for a NiFi cluster
> # Configuring LDAP authentication & authorization for NiFi
> # Configuring Kerberos authentication & authorization for NiFi
> # Building a flow which uses the {{Wait}}/{{Notify}} processors
> # Building a flow which uses the {{*Record}} processors
> # Converting a legacy flow which used individual flowfile processing to use the {{*Record}}
processors
> # Deploying NiFi on Kubernetes via Docker containers
> # Configuring TLS for NiFi Registry (and integrating with TLS NiFi)
> # Configuring LDAP authentication & authorization for NiFi Registry



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message