[jira] [Created] (NIFI-7319) Provide prescriptive documentation for common tasks

["Andy LoPresto (Jira)" <ji...@apache.org>]

Andy LoPresto created NIFI-7319:
-----------------------------------

             Summary: 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 & Website
    Affects Versions: 1.11.4
            Reporter: Andy LoPresto
            Assignee: Andy LoPresto


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)