[
https://issues.apache.org/jira/browse/NIFI-4839?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16371324#comment-16371324
]
ASF GitHub Bot commented on NIFI-4839:
--------------------------------------
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?
> Create a CLI in NiFi Toolkit to interact with NIFi Registry/deploy flows
> ------------------------------------------------------------------------
>
> Key: NIFI-4839
> URL: https://issues.apache.org/jira/browse/NIFI-4839
> Project: Apache NiFi
> Issue Type: Improvement
> Reporter: Bryan Bende
> Assignee: Bryan Bende
> Priority: Major
>
> Now that we have NiFi Registry and the ability to import/upgrade flows in
> NiFi, we should offer a command-line tool to interact with these REST
> end-points. This could part of NiFi Toolkit and would help people potentially
> automate some of these operations.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
