falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ajay Yadava (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-1587) Divide FalconCLI.twiki into sub sections for different modules on the lines of REST Api
Date Mon, 16 Nov 2015 11:31:11 GMT

    [ https://issues.apache.org/jira/browse/FALCON-1587?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15006549#comment-15006549
] 

Ajay Yadava commented on FALCON-1587:
-------------------------------------

I agree that it is an improvement over the existing structure. However, I think all commands
warrant a dedicated page if documented properly. A good documentation of each command should
contain at least the following 
1. Introduction to sample use cases of the command.
2. Discuss all options and their default values with examples.
3. Validations with examples
4. Error scenarios with examples

Currently we don't do a good job at documenting the CLI and hence a page looks too much for
each command but it will set the base structure for properly documenting each command. I hope
that in future when someone follows same structure and writes only two lines in the entire
page for documentation it will make them conscious to do a better job at it ;)



> 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
>              Labels: docs, newbie
>         Attachments: 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)

Mime
View raw message