Github user ijokarumawak commented on a diff in the pull request:
https://github.com/apache/nifi/pull/2143#discussion_r143318740
--- Diff:
nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/CreateHadoopSequenceFile.java
---
@@ -64,7 +64,8 @@
@SideEffectFree
@InputRequirement(Requirement.INPUT_REQUIRED)
@Tags({"hadoop", "sequence file", "create", "sequencefile"})
-@CapabilityDescription("Creates Hadoop Sequence Files from incoming flow
files")
+@CapabilityDescription("Creates Hadoop Sequence Files from incoming flow
files."
+ + " If you want to use SSL-secured file system like swebhdfs,
please see the 'SSL Configuration' topic of the 'Additional Details' of
PutHDFS.")
--- End diff --
@joewitt I agree, the explanation is not a 'capability description' rather
a documentation for configuration detail.
Is there any better place to write a common topic like this for components
within a NAR package? Something like 'package.html' in Javadoc, describing what
the NAR includes and common configuration, what type of flow user can construct
with provided processors ... etc. Is there any improvement going on in
'Extension Registry' sub project for such documentation? If not, does it sounds
helpful? If so, I will raise a JIRA to add 'bundle.html' or 'nar.html'
(Probably with Markdown support). How do you think?
---
