Github user bbende commented on the issue:
https://github.com/apache/nifi/pull/2477
@pvillard31 thanks for the feedback! Regarding the docs...
Long-term I do agree that our admin guide has become quite lengthy and hard
to find information, and we should probably spin-off a "Toolkit Guide", but I
think this would be a bigger effort that could follow on later.
Even if we do that though, I want to avoid having a manually maintained
list of commands and there usage. It would likely always be out of date as
people add new commands and have no idea there is a doc somewhere else, kind of
like if you added a processor to NiFi and had to remember to manually update
docs somewhere else. The interactive shell should give all the help via "help",
"help -v", and "command help". So whatever docs we write should focus more on
scenarios/tasks that can be accomplished.
For now I would say either..
A) Leave the README and maybe add a little bit more information
B) Move the README contents to a section in the admin guide
Then later we can figure out the Toolkit Guide idea, and could consider
fancy things like auto-generating docs for the CLI using annotations like
processors have :)
Thoughts?
---
