[
https://issues.apache.org/jira/browse/FALCON-1587?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15012768#comment-15012768
]
Srikanth Sundarrajan commented on FALCON-1587:
----------------------------------------------
I am guessing we intend to document our CLI in sufficient detail (similar to
[this|http://docs.aws.amazon.com/cli/latest/reference/ec2/allocate-address.html]).
If so am +1 for breaking each option to a separate page with a TOC/index page
similar to
[this|http://docs.aws.amazon.com/cli/latest/reference/ec2/index.html] or
[this|https://technet.microsoft.com/en-us/library/bb491051.aspx]. If it remains
as brief, we are better of with a single page, to reduce documentation
maintenance overheads.
> 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)
