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 subversion and git services (JIRA)" <ji...@apache.org> on 2015/02/03 05:22:36 UTC

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

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

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

Commit 9c61bdb1025d78d49907321f29f91e8dad922fa0 in incubator-nifi's branch refs/heads/develop from [~mcgilman]
[ https://git-wip-us.apache.org/repos/asf?p=incubator-nifi.git;h=9c61bdb ]

NIFI-162:
- Initial commit of the updated website. Contains copies of current pages and links to existing documents.

> 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, Tools and Build
>         Environment: apache nifi website
>            Reporter: Joseph Witt
>            Assignee: Joseph Witt
>            Priority: Critical
>              Labels: documentation
>         Attachments: NIFI-162.patch, NIFI-162.patch, NIFI-162.patch
>
>
> Perspectives / Flow of Documentation:
> - Overview
> -- What problem does NiFi solve?
> -- What is the general design philosophy of NiFi?
> -- What are some of the key features?
> - User Guide
> -- 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
> - System Administration Guide
> --- How to install
> --- Best practice configuration
> --- Security / Hardening
> --- Controlling access/levels of access
> - Developer Guide
> -- What are the extension points
> -- What is a NAR and what does the Classloader hierarchy/model look like?
> -- 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)