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 Wed, 18 Nov 2015 13:38:11 GMT

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

Ajay Yadava commented on FALCON-1587:

I understand having all commands in one page will make the page longer(which is probably what
you are trying to avoid), but if we have clear sections it will still look neat. 
This is most definitely not the intention and I will probably think about things like cache
tags etc. rather than dividing into multiple pages.

And, the page content is not that big that it should affect page loading
It definitely looks odd right now to have one page for each command considering how terse
the documentation is and I have explained the rationale partially in one of the comments above
and I will try to highlight it here again. We intend to document each command much more thoroughly
and standardize on a template on the following lines

1. Introduction to sample use cases of the command.
2. Discuss all options and their default values with examples.
3. Validations of each option and their combinations with examples
4. Error scenarios with examples

> 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

View raw message