[
https://issues.apache.org/jira/browse/NIFI-1210?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15020807#comment-15020807
]
Tony Kurc commented on NIFI-1210:
---------------------------------
Patch applies and builds fine. There are some end of line whitespaces in it
which git complains about, but I don't believe we care about that in the adoc.
One things which I believe is inaccurate: in the flow.xml.gz section, it reads
"still named nifi.xml.gz". That's either supposed to be flow.xml.gz or "still"
should be removed. If you tell me I'm wrong, I'm +1.
A couple *really* minor issues that I'll upload a patch for.
1. I noticed you fixed some misspellings. We have an errant "catagory" that I
noticed as I was skimming and looking for typos
{noformat}
tkurc@computer:~/nifi/nifi-docs/src/main/asciidoc$ grep -n "catagory"
user-guide.adoc
540:The Add Controller Service window opens. This window is similar to the Add
Processor window. It provides a list of the available Controller Services on
the right and a tag cloud, showing the most common catagory tags used for
Controller Services, on the left. The DFM may click any tag in the tag cloud in
order to narrow down the list of Controller Services to those that fit the
categories desired. The DFM may also use the Filter field at the top of the
window to search for the desired Controller Service. Upon selecting a
Controller Service from the list, the DFM can see a description of the the
service below. Select the desired controller service and click Add, or simply
double-click the name of the service to add it.
{noformat}
2. really minor, you have "Once a Processor has been dragged onto the Canvas",
but it seems like most other places it is lower case "the canvas". It is called
"the graph" once
{noformat}
tkurc@computer:~/nifi/nifi-docs/src/main/asciidoc$ grep -n Canvas
user-guide.adoc
170:=== Adding Components to the Canvas
200:Once a Processor has been dragged onto the Canvas, the user may interact
with it by right-clicking on the Processor and selecting an option from
254:Once a Process Group has been dragged onto the Canvas, the user may
interact with it by right-clicking on the Process Group and selecting an option
from
285:Once a Remote Process Group has been dragged onto the Canvas, the user may
interact with it by right-clicking on the Remote Process Group and selecting an
option from
tkurc@computer:~/nifi/nifi-docs/src/main/asciidoc$ grep -n "the canvas"
user-guide.adoc | wc
40 873 5079
tkurc@computer:~/nifi/nifi-docs/src/main/asciidoc$ grep -n "dragged onto the
graph" user-guide.adoc
182: When a Processor is dragged onto the graph, the user is presented with
a dialog to choose which type of Processor to use:
{noformat}
Content-wise, I enjoyed reading it. I was a little confused a bit by the Copy
or Paste (not enough that I would say "don't commit!"). I was fiddling around
with the UI, and it looks like a Copy "and sometimes also" Paste, and the Paste
seems to shows up if there is something on the clipboard, but Copy doesn't go
away. How is that Paste different from a right-click on the canvas?
> Updates to User Guide for version 0.4.0
> ---------------------------------------
>
> Key: NIFI-1210
> URL: https://issues.apache.org/jira/browse/NIFI-1210
> Project: Apache NiFi
> Issue Type: Task
> Components: Documentation & Website
> Affects Versions: 0.3.0
> Reporter: Jennifer Patricia Barnabee
> Assignee: Jennifer Patricia Barnabee
> Fix For: 0.4.0
>
> Attachments: NIFI-1210.patch
>
>
> This ticket is for making the following changes to the User Guide:
> - Add a description of the flow.xml.gz to the Terminology section since we
> hadn't previously mentioned flow.xml.gz anywhere in the guide (yikes!)
> - Add a "connection menu" section and image to the Connecting Components
> section so as to have a place to describe the new "Empty Queue" feature.
> - Add a processor menu, process group menu, and remote process group menu
> description and image to the section on adding components to the flow.
> - Fix a few typos.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
