[jira] [Commented] (NIFI-162) Create overall documentation/engage theme on website

["Joseph Witt (JIRA)" <ji...@apache.org>]

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

Joseph Witt commented on NIFI-162:
----------------------------------

My hope is that quick-start means little more than an index of pointers to key parts of this overall living document.

> Create overall documentation/engage theme on website
> ----------------------------------------------------
>
>                 Key: NIFI-162
>                 URL: https://issues.apache.org/jira/browse/NIFI-162
>             Project: Apache NiFi
>          Issue Type: Task
>          Components: Documentation & Website
>         Environment: apache nifi website
>            Reporter: Joseph Witt
>            Assignee: Joseph Witt
>            Priority: Critical
>              Labels: documentation
>
> Perspectives / Flow of Documentation:
> - All
> -- What problem does NiFi solve?
> -- What is the general design philosophy of NiFi?
> -- What are some of the key features?
> - User
> -- SA
> --- How to install
> --- Best practice configuration
> --- Security / Hardening
> --- Controlling access/levels of access
> -- Dataflow Manager
> --- How to build flows
> --- Create / Share / Use templates
> --- How to monitor behavior/performance
> --- Data Provenance
> --- In-line documentation / change history
> -- Observer
> --- Read-only access
> - Developer
> -- What are the extension points
> -- How to build extensions
> -- Thinking about the right abstraction and considering cohesion/coupling for a processor or extension in general
> -- Emphasis on the user experience - the in-line documentation, the naming of properties, is a custom UI needed, etc..
> -- Key things to consider/design considerations/strengths/limitations
> -- How to contribute to Apache NiFI
> These are meant to flow logically from top to bottom where we want to gain interest in reading further by explaining the 'why' / the 'context'.  Then it flows into usage and capabilities of the application.  Then we flow into how to extend the application's capabilities to suit your needs and to contribute back to the community.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)