[
https://issues.apache.org/jira/browse/FALCON-1587?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15010998#comment-15010998
]
Ajay Yadava commented on FALCON-1587:
-------------------------------------
The main intention behind this JIRA is to improve documentation of FalconCLI
commands and I have repeatedly received feedback during demos and answering
queries from new users that RESTApi documentation structure is far better. I
received this feedback several times and most recently I received this feedback
from another user during a code review (I will find and attach the link in a
while). This repeated feedback was the main motivation behind this JIRA.
The current structure doesn't serve the core purpose of documentation, ease of
navigation is only a nice to have. IMHO, new structure facilitates and
encourages developers to write thorough documentation. Makes sense?
> Divide FalconCLI.twiki into sub sections for different modules on the lines
> of REST Api
> ---------------------------------------------------------------------------------------
>
> Key: FALCON-1587
> URL: https://issues.apache.org/jira/browse/FALCON-1587
> Project: Falcon
> Issue Type: Improvement
> Components: docs
> Reporter: Ajay Yadava
> Assignee: Praveen Adlakha
> Labels: docs, newbie
> Attachments: FALCON-1587-v1.patch, FALCON-1587-v2.patch,
> falcon_1587.patch
>
>
> Currently FalconCLI.twiki is one monolithic file. We should create another
> file for each command and link it back in FalconCLI.twiki, just like REST Api.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
