nifi-commits 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-162) Create overall documentation/engage theme on website
Date Sat, 27 Dec 2014 04:18:13 GMT

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

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

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

NIFI-162 all doc components prepped and integrated to build process.  Now just to fill in
content


> 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
>             Fix For: 0.0.1
>
>
> 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)

Mime
View raw message