[
https://issues.apache.org/jira/browse/SQOOP-2826?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jarek Jarcec Cecho updated SQOOP-2826:
--------------------------------------
Description:
Our current pages describing connectors are heavily outdated. This happened
because we've added bunch of new configuration properties in various patches,
but forget to update the docs. Whereas we could force every connector changing
patch to also update the docs, I think that keeping the same information on two
places is tedious. Much better option would be to automatically generate
connector documentation pages from our code.
To be very specific, I can see at least two areas where auto generating content
would really help:
* [Generating input list for
connectors|http://sqoop.apache.org/docs/1.99.6/Connectors.html]
* [Generating command line
parameters|http://sqoop.apache.org/docs/1.99.6/CommandLineClient.html]
I'm sure that there will be others :)
was:Our current pages describing connectors are heavily outdated. This
happened because we've added bunch of new configuration properties in various
patches, but forget to update the docs. Whereas we could force every connector
changing patch to also update the docs, I think that keeping the same
information on two places is tedious. Much better option would be to
automatically generate connector documentation pages from our code.
> Sqoop2: Doc: Auto-generate connector pages
> ------------------------------------------
>
> Key: SQOOP-2826
> URL: https://issues.apache.org/jira/browse/SQOOP-2826
> Project: Sqoop
> Issue Type: Sub-task
> Reporter: Jarek Jarcec Cecho
> Assignee: Jarek Jarcec Cecho
> Fix For: 1.99.7
>
>
> Our current pages describing connectors are heavily outdated. This happened
> because we've added bunch of new configuration properties in various patches,
> but forget to update the docs. Whereas we could force every connector
> changing patch to also update the docs, I think that keeping the same
> information on two places is tedious. Much better option would be to
> automatically generate connector documentation pages from our code.
> To be very specific, I can see at least two areas where auto generating
> content would really help:
> * [Generating input list for
> connectors|http://sqoop.apache.org/docs/1.99.6/Connectors.html]
> * [Generating command line
> parameters|http://sqoop.apache.org/docs/1.99.6/CommandLineClient.html]
> I'm sure that there will be others :)
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
