[jira] [Created] (SQOOP-2667) Sqoop2: Improve documentation

["Jarek Jarcec Cecho (JIRA)" <ji...@apache.org>]

Jarek Jarcec Cecho created SQOOP-2667:
-----------------------------------------

             Summary: Sqoop2: Improve documentation
                 Key: SQOOP-2667
                 URL: https://issues.apache.org/jira/browse/SQOOP-2667
             Project: Sqoop
          Issue Type: Bug
    Affects Versions: 1.99.6
            Reporter: Jarek Jarcec Cecho
            Assignee: Jarek Jarcec Cecho
             Fix For: 1.99.7


We've put together roots of current documentation system more then 3 years ago for our first 1.99.1 cut of Sqoop 2.  We've only incrementally added few pages since then. I recently looked into the docs more carefully as I wanted to improve HDFS connector and I would like to propose quite huge overhaul - few of the things that immediately came to my mind:

* I'm really missing a table of context on each page to navigate though the entire documentation suite (in some side menu or something)
* On any formatting error, we print out exception to the documentation and won't fail the build.
* We build the docs in all profiles, even though that it make sense only for {{binary}} profile.
* The connector docs are really, really old - bunch of newly added arguments are not mentioned there.
* In terms of connectors - it seems to me that the docs are focusing on dev rather then end user, so I would like to add more context there.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)