falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Adam Kawa (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-1069) Documentation Enhancements
Date Wed, 04 Mar 2015 19:49:41 GMT

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

Adam Kawa commented on FALCON-1069:

* List of interesting blog posts, videos and presentations about Falcon
* Up-to-date roadmap https://cwiki.apache.org/confluence/display/FALCON/Roadmap

> Documentation Enhancements
> --------------------------
>                 Key: FALCON-1069
>                 URL: https://issues.apache.org/jira/browse/FALCON-1069
>             Project: Falcon
>          Issue Type: Improvement
>            Reporter: Ajay Yadava
>              Labels: docs, documentation
> Current falcon documentation has a lot of scope for improvement. This JIRA is to suggest,
discuss and list the tasks for enhancements to the documentation. 
> To start off
> * Reorganise the documentation to a more user friendly style. 
> * List out and document various sections of documentations. This should also include
inadequately documented or commonly confusing topics.
> * Separate documentation for users, operations & developers.
> * Automatic documentation for REST APIs
> * Automatic updates for the documentation.
> * More examples on various scenarios/ use cases for the cli/rest api calls.
> * More detailed Release notes (not just changes.txt) and backward incompatible changes
should be highlighted along with the migration strategies.
> * Migration or mitigation steps for backward incompatible changes should be maintained
along with the patches.
> * Better and more intuitive versioning of the documentation(current one is confusing
- version should be parent of the entire documentation)

This message was sent by Atlassian JIRA

View raw message