Ajay Yadava created FALCON-1069:
-----------------------------------
Summary: Documentation Enhancements
Key: FALCON-1069
URL: https://issues.apache.org/jira/browse/FALCON-1069
Project: Falcon
Issue Type: Improvement
Reporter: Ajay Yadava
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
(v6.3.4#6332)
