[
https://issues.apache.org/jira/browse/NIFI-1028?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15246152#comment-15246152
]
ASF GitHub Bot commented on NIFI-1028:
--------------------------------------
Github user olegz commented on a diff in the pull request:
https://github.com/apache/nifi/pull/339#discussion_r60103526
--- Diff: nifi-docs/src/main/asciidoc/nifi-in-depth.adoc ---
@@ -0,0 +1,209 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+Apache NiFi In Depth
+====================
+Apache NiFi Team <[email protected]>
+:homepage: http://nifi.apache.org
+
+Intro
+-----
+This advanced level document is aimed at providing an in-depth look at the
implementation and design decisions of NiFi. It assumes the reader has read
enough of the other documentation to know the basics of NiFi.
+
+FlowFiles are at the heart of NiFi and its flow-based design. A FlowFile
is just a collection of attributes and a pointer to content, which is
associated with one or more provenance events. The attributes are key/value
pairs that act as the metadata for the FlowFile, such as the FlowFile filename.
The content is the actual data or the payload of the file. Provenance is a
record of what’s happened to the FlowFile. Each one of these parts has its own
repository (repo) for storage.
--- End diff --
May be instead of "FlowFile is just a collection of attributes and a
pointer to content" use "FlowFile is a data record which consists of pointer to
the content (payload) and attributes to support such content". The ordering of
_content_ then _attributes_ is also important, otherwise what I am reading is
that "FlowFile is just attributes. . ."
> Document FlowFiles and the repos in depth
> -----------------------------------------
>
> Key: NIFI-1028
> URL: https://issues.apache.org/jira/browse/NIFI-1028
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Reporter: Joseph Percivall
> Assignee: Joseph Percivall
>
> Currently the Documentation gives an overview of the FlowFiles and repos but
> users need a good in depth look into what a FlowFile is and how it changes
> when it goes through a flow, and there needs to be in depth documentation on
> the three repositories.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
