[MINIFI-55] Improvements to documentation

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.0.1
• Component/s: Documentation
• Assignee: Aldrin Piri
• Reporter: Aldrin Piri
• Created: 08/Jul/16 17:12
• Updated: 08/Aug/16 19:29
• Resolved: 08/Aug/16 18:51

Description

During the 0.0.1 release feedback was provided as to how to make the associated artifacts more usable as well as other suggested corrections.

From alopresto

README.md:

• Could we use HTTPS links when possible?
• The note about the time to run a parallel Maven build says on a moderate dev laptop it should complete in less than 10 minutes. While true, a more accurate statement would be < 2 minutes.
• The mkdir example references “example-nifi-deploy” and “example-minifi-deploy” interchangeably.

System Admin Guide:

• Could we use HTTPS links when possible?

From joewitt:

1) minifi-toolkit awareness
The build helper email references this which makes knowledge of it
available. But I didn't initially notice any references to it in the
system admin guide doc or README entries. Might need to call it out
more or provide a more prescriptive pointer to how to build it, find
it, use it.

2) minifi-toolkit execution

When running config.sh it says
"
Transform Usage:

java org.apache.nifi.minifi.toolkit.configuration.ConfigMain transform
INPUT_FILE OUTPUT_FILE
"

But I ended up just running 'bin/config.sh IN.xml OUT.yml' and it
worked great so the java classname bits there are probably superfluous
or only apply to those running without the script.

Issue Links

• relates to: MINIFI-81 Adjust usage information for minifi-toolkit executable