You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sqoop.apache.org by Jarek Cecho <ja...@apache.org> on 2015/11/17 18:54:32 UTC
Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure in
sphinx for our docs
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/
-----------------------------------------------------------
Review request for Sqoop.
Bugs: SQOOP-2694
https://issues.apache.org/jira/browse/SQOOP-2694
Repository: sqoop-sqoop2
Description
-------
Even though that the patch looks large, it's actually quite simple. All it does is:
* Moving files around to various directories so that it's easier to build the tree structure for sphinx.
* Changes theme to one that have side panel
* Fixes links for new theme that actually have the side panel (to verify the tree structure)
* Enables build failures if the docs can't be build properly
I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
Diffs
-----
docs/pom.xml 079e896
docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
docs/src/site/sphinx/ClientAPI.rst 9626878
docs/src/site/sphinx/CommandLineClient.rst 8c4c592
docs/src/site/sphinx/Connector-FTP.rst cc10d68
docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
docs/src/site/sphinx/Connector-Kafka.rst b6bca14
docs/src/site/sphinx/Connector-Kite.rst 414ad8a
docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
docs/src/site/sphinx/DevEnv.rst 3b72e06
docs/src/site/sphinx/Installation.rst 9d56875
docs/src/site/sphinx/RESTAPI.rst 39aabc0
docs/src/site/sphinx/Repository.rst 55daf2e
docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
docs/src/site/sphinx/Tools.rst fb0187a
docs/src/site/sphinx/Upgrade.rst 385c5ae
docs/src/site/sphinx/admin.rst PRE-CREATION
docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
docs/src/site/sphinx/conf.py 6a9bf31
docs/src/site/sphinx/dev.rst PRE-CREATION
docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
docs/src/site/sphinx/index.rst a18fad2
docs/src/site/sphinx/security.rst PRE-CREATION
docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
docs/src/site/sphinx/user.rst PRE-CREATION
docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
Diff: https://reviews.apache.org/r/40393/diff/
Testing
-------
Thanks,
Jarek Cecho
Re: Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure
in sphinx for our docs
Posted by Jarek Cecho <ja...@apache.org>.
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/src/site/sphinx/conf.py, line 111
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128733#file1128733line111>
> >
> > this is a good idea. although, i think this should be in a different jira/code review.
> >
> > also, my eyes tell me sphinx_rtd_theme or classic look better. what do you think?
>
> Jarek Cecho wrote:
> Yeah I was debatting that myself. The reason why I did include the theme change in this patch is that without changing the theme, one can't really verify whether the goal of this JIRA - have single document structure - have been accomplished. But I'm happy to push it to a separate JIRA if you feel that it deserves it.
>
> In terms of choice the "sphinx_rtd_theme" is actually not part of the default sphinx installation - one have to manually install the template which I did not wanted to do. I would like to the build to be matter of simple mvn clean site -Pbinary without unnecessary external dependencies. The "classic" would be an option - I just somehow didn't like it (no objective opinion).
>
> Abraham Fine wrote:
> i don't think it would be good for the sqoop project to let me have the final word in aesthetic appeal
I feel that I'm not the one who should make final choice either. Let's commit this theme change for now as it's important to verify the functionality and then I'll send email to dev@ soliciting opinions from the community at large :)
https://issues.apache.org/jira/browse/SQOOP-2696
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/src/site/sphinx/conf.py, line 103
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128733#file1128733line103>
> >
> > remove?
>
> Jarek Cecho wrote:
> It's unrelated line to the patch - the file conf.py contains a lot of similar lines and probably should be cleaned up completely. I would prefer to do that as a follow up JIRA to not side track this one if you don't mind?
https://issues.apache.org/jira/browse/SQOOP-2697
On Nov. 17, 2015, 10:55 p.m., Jarek Cecho wrote:
> > git found a few issues with the patch
> >
> > i am not sure how many of these are new and how many were just moved to new locations, but we should probably clean them up
> >
> > docs/src/site/sphinx/admin/Installation.rst:102: new blank line at EOF.
> > docs/src/site/sphinx/admin/Tools.rst:61: leftover conflict marker
> > docs/src/site/sphinx/admin/Tools.rst:124: new blank line at EOF.
> > docs/src/site/sphinx/admin/Upgrade.rst:17: leftover conflict marker
> > docs/src/site/sphinx/admin/Upgrade.rst:19: leftover conflict marker
> > docs/src/site/sphinx/dev/ClientAPI.rst:264: trailing whitespace.
> > + //Check job status for a running job
> > docs/src/site/sphinx/dev/DevEnv.rst:57: new blank line at EOF.
> > docs/src/site/sphinx/dev/Repository.rst:334: new blank line at EOF.
> > docs/src/site/sphinx/user/CommandLineClient.rst:361: trailing whitespace.
> > + create job --from 1 --to 2 or create job --f 1 --t 2
> > docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst:221: trailing whitespace.
> > + 2014-11-04 20:09:16 PST: RUNNING - 0.00 %
> > docs/src/site/sphinx/user/connectors/Connector-Kafka.rst:64: new blank line at EOF.
>
> Jarek Cecho wrote:
> Good point - all of them are remnants of the past in files that I did not changed at alll. Would you mind fixing the warning separately? I would like to keep the JIRA simple in terms of what files have been moved versus what files were also changed.
>
> Abraham Fine wrote:
> agreed, lets put it in a separate jira
https://issues.apache.org/jira/browse/SQOOP-2695
- Jarek
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/#review106944
-----------------------------------------------------------
On Nov. 17, 2015, 5:54 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40393/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 5:54 p.m.)
>
>
> Review request for Sqoop.
>
>
> Bugs: SQOOP-2694
> https://issues.apache.org/jira/browse/SQOOP-2694
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> Even though that the patch looks large, it's actually quite simple. All it does is:
>
> * Moving files around to various directories so that it's easier to build the tree structure for sphinx.
> * Changes theme to one that have side panel
> * Fixes links for new theme that actually have the side panel (to verify the tree structure)
> * Enables build failures if the docs can't be build properly
>
> I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
>
>
> Diffs
> -----
>
> docs/pom.xml 079e896
> docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
> docs/src/site/sphinx/ClientAPI.rst 9626878
> docs/src/site/sphinx/CommandLineClient.rst 8c4c592
> docs/src/site/sphinx/Connector-FTP.rst cc10d68
> docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
> docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
> docs/src/site/sphinx/Connector-Kafka.rst b6bca14
> docs/src/site/sphinx/Connector-Kite.rst 414ad8a
> docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
> docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
> docs/src/site/sphinx/DevEnv.rst 3b72e06
> docs/src/site/sphinx/Installation.rst 9d56875
> docs/src/site/sphinx/RESTAPI.rst 39aabc0
> docs/src/site/sphinx/Repository.rst 55daf2e
> docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
> docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
> docs/src/site/sphinx/Tools.rst fb0187a
> docs/src/site/sphinx/Upgrade.rst 385c5ae
> docs/src/site/sphinx/admin.rst PRE-CREATION
> docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
> docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
> docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
> docs/src/site/sphinx/conf.py 6a9bf31
> docs/src/site/sphinx/dev.rst PRE-CREATION
> docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
> docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
> docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
> docs/src/site/sphinx/index.rst a18fad2
> docs/src/site/sphinx/security.rst PRE-CREATION
> docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/user.rst PRE-CREATION
> docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
> docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
> docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
>
> Diff: https://reviews.apache.org/r/40393/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure
in sphinx for our docs
Posted by Abraham Fine <ab...@cloudera.com>.
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/src/site/sphinx/conf.py, line 111
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128733#file1128733line111>
> >
> > this is a good idea. although, i think this should be in a different jira/code review.
> >
> > also, my eyes tell me sphinx_rtd_theme or classic look better. what do you think?
>
> Jarek Cecho wrote:
> Yeah I was debatting that myself. The reason why I did include the theme change in this patch is that without changing the theme, one can't really verify whether the goal of this JIRA - have single document structure - have been accomplished. But I'm happy to push it to a separate JIRA if you feel that it deserves it.
>
> In terms of choice the "sphinx_rtd_theme" is actually not part of the default sphinx installation - one have to manually install the template which I did not wanted to do. I would like to the build to be matter of simple mvn clean site -Pbinary without unnecessary external dependencies. The "classic" would be an option - I just somehow didn't like it (no objective opinion).
i don't think it would be good for the sqoop project to let me have the final word in aesthetic appeal
On Nov. 17, 2015, 10:55 p.m., Jarek Cecho wrote:
> > git found a few issues with the patch
> >
> > i am not sure how many of these are new and how many were just moved to new locations, but we should probably clean them up
> >
> > docs/src/site/sphinx/admin/Installation.rst:102: new blank line at EOF.
> > docs/src/site/sphinx/admin/Tools.rst:61: leftover conflict marker
> > docs/src/site/sphinx/admin/Tools.rst:124: new blank line at EOF.
> > docs/src/site/sphinx/admin/Upgrade.rst:17: leftover conflict marker
> > docs/src/site/sphinx/admin/Upgrade.rst:19: leftover conflict marker
> > docs/src/site/sphinx/dev/ClientAPI.rst:264: trailing whitespace.
> > + //Check job status for a running job
> > docs/src/site/sphinx/dev/DevEnv.rst:57: new blank line at EOF.
> > docs/src/site/sphinx/dev/Repository.rst:334: new blank line at EOF.
> > docs/src/site/sphinx/user/CommandLineClient.rst:361: trailing whitespace.
> > + create job --from 1 --to 2 or create job --f 1 --t 2
> > docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst:221: trailing whitespace.
> > + 2014-11-04 20:09:16 PST: RUNNING - 0.00 %
> > docs/src/site/sphinx/user/connectors/Connector-Kafka.rst:64: new blank line at EOF.
>
> Jarek Cecho wrote:
> Good point - all of them are remnants of the past in files that I did not changed at alll. Would you mind fixing the warning separately? I would like to keep the JIRA simple in terms of what files have been moved versus what files were also changed.
agreed, lets put it in a separate jira
- Abraham
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/#review106944
-----------------------------------------------------------
On Nov. 17, 2015, 5:54 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40393/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 5:54 p.m.)
>
>
> Review request for Sqoop.
>
>
> Bugs: SQOOP-2694
> https://issues.apache.org/jira/browse/SQOOP-2694
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> Even though that the patch looks large, it's actually quite simple. All it does is:
>
> * Moving files around to various directories so that it's easier to build the tree structure for sphinx.
> * Changes theme to one that have side panel
> * Fixes links for new theme that actually have the side panel (to verify the tree structure)
> * Enables build failures if the docs can't be build properly
>
> I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
>
>
> Diffs
> -----
>
> docs/pom.xml 079e896
> docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
> docs/src/site/sphinx/ClientAPI.rst 9626878
> docs/src/site/sphinx/CommandLineClient.rst 8c4c592
> docs/src/site/sphinx/Connector-FTP.rst cc10d68
> docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
> docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
> docs/src/site/sphinx/Connector-Kafka.rst b6bca14
> docs/src/site/sphinx/Connector-Kite.rst 414ad8a
> docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
> docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
> docs/src/site/sphinx/DevEnv.rst 3b72e06
> docs/src/site/sphinx/Installation.rst 9d56875
> docs/src/site/sphinx/RESTAPI.rst 39aabc0
> docs/src/site/sphinx/Repository.rst 55daf2e
> docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
> docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
> docs/src/site/sphinx/Tools.rst fb0187a
> docs/src/site/sphinx/Upgrade.rst 385c5ae
> docs/src/site/sphinx/admin.rst PRE-CREATION
> docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
> docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
> docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
> docs/src/site/sphinx/conf.py 6a9bf31
> docs/src/site/sphinx/dev.rst PRE-CREATION
> docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
> docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
> docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
> docs/src/site/sphinx/index.rst a18fad2
> docs/src/site/sphinx/security.rst PRE-CREATION
> docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/user.rst PRE-CREATION
> docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
> docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
> docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
>
> Diff: https://reviews.apache.org/r/40393/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure
in sphinx for our docs
Posted by Jarek Cecho <ja...@apache.org>.
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/pom.xml, line 73
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128710#file1128710line73>
> >
> > why did we need to change the version?
To get the ability to fail maven build if building the docs fails:
https://github.com/tomdz/sphinx-maven/commit/d282c375d693ff26f1e7293e3509c135d5763e7c
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/src/site/sphinx/conf.py, line 103
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128733#file1128733line103>
> >
> > remove?
It's unrelated line to the patch - the file conf.py contains a lot of similar lines and probably should be cleaned up completely. I would prefer to do that as a follow up JIRA to not side track this one if you don't mind?
> On Nov. 17, 2015, 10:55 p.m., Abraham Fine wrote:
> > docs/src/site/sphinx/conf.py, line 111
> > <https://reviews.apache.org/r/40393/diff/1/?file=1128733#file1128733line111>
> >
> > this is a good idea. although, i think this should be in a different jira/code review.
> >
> > also, my eyes tell me sphinx_rtd_theme or classic look better. what do you think?
Yeah I was debatting that myself. The reason why I did include the theme change in this patch is that without changing the theme, one can't really verify whether the goal of this JIRA - have single document structure - have been accomplished. But I'm happy to push it to a separate JIRA if you feel that it deserves it.
In terms of choice the "sphinx_rtd_theme" is actually not part of the default sphinx installation - one have to manually install the template which I did not wanted to do. I would like to the build to be matter of simple mvn clean site -Pbinary without unnecessary external dependencies. The "classic" would be an option - I just somehow didn't like it (no objective opinion).
On Nov. 17, 2015, 10:55 p.m., Jarek Cecho wrote:
> > git found a few issues with the patch
> >
> > i am not sure how many of these are new and how many were just moved to new locations, but we should probably clean them up
> >
> > docs/src/site/sphinx/admin/Installation.rst:102: new blank line at EOF.
> > docs/src/site/sphinx/admin/Tools.rst:61: leftover conflict marker
> > docs/src/site/sphinx/admin/Tools.rst:124: new blank line at EOF.
> > docs/src/site/sphinx/admin/Upgrade.rst:17: leftover conflict marker
> > docs/src/site/sphinx/admin/Upgrade.rst:19: leftover conflict marker
> > docs/src/site/sphinx/dev/ClientAPI.rst:264: trailing whitespace.
> > + //Check job status for a running job
> > docs/src/site/sphinx/dev/DevEnv.rst:57: new blank line at EOF.
> > docs/src/site/sphinx/dev/Repository.rst:334: new blank line at EOF.
> > docs/src/site/sphinx/user/CommandLineClient.rst:361: trailing whitespace.
> > + create job --from 1 --to 2 or create job --f 1 --t 2
> > docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst:221: trailing whitespace.
> > + 2014-11-04 20:09:16 PST: RUNNING - 0.00 %
> > docs/src/site/sphinx/user/connectors/Connector-Kafka.rst:64: new blank line at EOF.
Good point - all of them are remnants of the past in files that I did not changed at alll. Would you mind fixing the warning separately? I would like to keep the JIRA simple in terms of what files have been moved versus what files were also changed.
- Jarek
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/#review106944
-----------------------------------------------------------
On Nov. 17, 2015, 5:54 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40393/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 5:54 p.m.)
>
>
> Review request for Sqoop.
>
>
> Bugs: SQOOP-2694
> https://issues.apache.org/jira/browse/SQOOP-2694
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> Even though that the patch looks large, it's actually quite simple. All it does is:
>
> * Moving files around to various directories so that it's easier to build the tree structure for sphinx.
> * Changes theme to one that have side panel
> * Fixes links for new theme that actually have the side panel (to verify the tree structure)
> * Enables build failures if the docs can't be build properly
>
> I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
>
>
> Diffs
> -----
>
> docs/pom.xml 079e896
> docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
> docs/src/site/sphinx/ClientAPI.rst 9626878
> docs/src/site/sphinx/CommandLineClient.rst 8c4c592
> docs/src/site/sphinx/Connector-FTP.rst cc10d68
> docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
> docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
> docs/src/site/sphinx/Connector-Kafka.rst b6bca14
> docs/src/site/sphinx/Connector-Kite.rst 414ad8a
> docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
> docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
> docs/src/site/sphinx/DevEnv.rst 3b72e06
> docs/src/site/sphinx/Installation.rst 9d56875
> docs/src/site/sphinx/RESTAPI.rst 39aabc0
> docs/src/site/sphinx/Repository.rst 55daf2e
> docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
> docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
> docs/src/site/sphinx/Tools.rst fb0187a
> docs/src/site/sphinx/Upgrade.rst 385c5ae
> docs/src/site/sphinx/admin.rst PRE-CREATION
> docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
> docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
> docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
> docs/src/site/sphinx/conf.py 6a9bf31
> docs/src/site/sphinx/dev.rst PRE-CREATION
> docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
> docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
> docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
> docs/src/site/sphinx/index.rst a18fad2
> docs/src/site/sphinx/security.rst PRE-CREATION
> docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/user.rst PRE-CREATION
> docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
> docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
> docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
>
> Diff: https://reviews.apache.org/r/40393/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure
in sphinx for our docs
Posted by Abraham Fine <ab...@cloudera.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/#review106944
-----------------------------------------------------------
docs/pom.xml (line 73)
<https://reviews.apache.org/r/40393/#comment165748>
why did we need to change the version?
docs/src/site/sphinx/conf.py (line 103)
<https://reviews.apache.org/r/40393/#comment165751>
remove?
docs/src/site/sphinx/conf.py (line 111)
<https://reviews.apache.org/r/40393/#comment165750>
this is a good idea. although, i think this should be in a different jira/code review.
also, my eyes tell me sphinx_rtd_theme or classic look better. what do you think?
git found a few issues with the patch
i am not sure how many of these are new and how many were just moved to new locations, but we should probably clean them up
docs/src/site/sphinx/admin/Installation.rst:102: new blank line at EOF.
docs/src/site/sphinx/admin/Tools.rst:61: leftover conflict marker
docs/src/site/sphinx/admin/Tools.rst:124: new blank line at EOF.
docs/src/site/sphinx/admin/Upgrade.rst:17: leftover conflict marker
docs/src/site/sphinx/admin/Upgrade.rst:19: leftover conflict marker
docs/src/site/sphinx/dev/ClientAPI.rst:264: trailing whitespace.
+ //Check job status for a running job
docs/src/site/sphinx/dev/DevEnv.rst:57: new blank line at EOF.
docs/src/site/sphinx/dev/Repository.rst:334: new blank line at EOF.
docs/src/site/sphinx/user/CommandLineClient.rst:361: trailing whitespace.
+ create job --from 1 --to 2 or create job --f 1 --t 2
docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst:221: trailing whitespace.
+ 2014-11-04 20:09:16 PST: RUNNING - 0.00 %
docs/src/site/sphinx/user/connectors/Connector-Kafka.rst:64: new blank line at EOF.
- Abraham Fine
On Nov. 17, 2015, 5:54 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40393/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 5:54 p.m.)
>
>
> Review request for Sqoop.
>
>
> Bugs: SQOOP-2694
> https://issues.apache.org/jira/browse/SQOOP-2694
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> Even though that the patch looks large, it's actually quite simple. All it does is:
>
> * Moving files around to various directories so that it's easier to build the tree structure for sphinx.
> * Changes theme to one that have side panel
> * Fixes links for new theme that actually have the side panel (to verify the tree structure)
> * Enables build failures if the docs can't be build properly
>
> I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
>
>
> Diffs
> -----
>
> docs/pom.xml 079e896
> docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
> docs/src/site/sphinx/ClientAPI.rst 9626878
> docs/src/site/sphinx/CommandLineClient.rst 8c4c592
> docs/src/site/sphinx/Connector-FTP.rst cc10d68
> docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
> docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
> docs/src/site/sphinx/Connector-Kafka.rst b6bca14
> docs/src/site/sphinx/Connector-Kite.rst 414ad8a
> docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
> docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
> docs/src/site/sphinx/DevEnv.rst 3b72e06
> docs/src/site/sphinx/Installation.rst 9d56875
> docs/src/site/sphinx/RESTAPI.rst 39aabc0
> docs/src/site/sphinx/Repository.rst 55daf2e
> docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
> docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
> docs/src/site/sphinx/Tools.rst fb0187a
> docs/src/site/sphinx/Upgrade.rst 385c5ae
> docs/src/site/sphinx/admin.rst PRE-CREATION
> docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
> docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
> docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
> docs/src/site/sphinx/conf.py 6a9bf31
> docs/src/site/sphinx/dev.rst PRE-CREATION
> docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
> docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
> docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
> docs/src/site/sphinx/index.rst a18fad2
> docs/src/site/sphinx/security.rst PRE-CREATION
> docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/user.rst PRE-CREATION
> docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
> docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
> docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
>
> Diff: https://reviews.apache.org/r/40393/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>
Re: Review Request 40393: SQOOP-2694 Sqoop2: Doc: Register structure
in sphinx for our docs
Posted by Abraham Fine <ab...@cloudera.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40393/#review106956
-----------------------------------------------------------
Ship it!
Ship It!
- Abraham Fine
On Nov. 17, 2015, 5:54 p.m., Jarek Cecho wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40393/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 5:54 p.m.)
>
>
> Review request for Sqoop.
>
>
> Bugs: SQOOP-2694
> https://issues.apache.org/jira/browse/SQOOP-2694
>
>
> Repository: sqoop-sqoop2
>
>
> Description
> -------
>
> Even though that the patch looks large, it's actually quite simple. All it does is:
>
> * Moving files around to various directories so that it's easier to build the tree structure for sphinx.
> * Changes theme to one that have side panel
> * Fixes links for new theme that actually have the side panel (to verify the tree structure)
> * Enables build failures if the docs can't be build properly
>
> I could probably separate the last two items to standalone JIRA, but I feel that the changes are so related, that it's better to do that as part of one commit.
>
>
> Diffs
> -----
>
> docs/pom.xml 079e896
> docs/src/site/sphinx/BuildingSqoop2.rst 7fbbb6b
> docs/src/site/sphinx/ClientAPI.rst 9626878
> docs/src/site/sphinx/CommandLineClient.rst 8c4c592
> docs/src/site/sphinx/Connector-FTP.rst cc10d68
> docs/src/site/sphinx/Connector-GenericJDBC.rst 347547d
> docs/src/site/sphinx/Connector-HDFS.rst c44b1b6
> docs/src/site/sphinx/Connector-Kafka.rst b6bca14
> docs/src/site/sphinx/Connector-Kite.rst 414ad8a
> docs/src/site/sphinx/Connector-SFTP.rst d25ea3f
> docs/src/site/sphinx/ConnectorDevelopment.rst 0e8ea92
> docs/src/site/sphinx/DevEnv.rst 3b72e06
> docs/src/site/sphinx/Installation.rst 9d56875
> docs/src/site/sphinx/RESTAPI.rst 39aabc0
> docs/src/site/sphinx/Repository.rst 55daf2e
> docs/src/site/sphinx/SecurityGuideOnSqoop2.rst 7194d3b
> docs/src/site/sphinx/Sqoop5MinutesDemo.rst 19115a2
> docs/src/site/sphinx/Tools.rst fb0187a
> docs/src/site/sphinx/Upgrade.rst 385c5ae
> docs/src/site/sphinx/admin.rst PRE-CREATION
> docs/src/site/sphinx/admin/Installation.rst PRE-CREATION
> docs/src/site/sphinx/admin/Tools.rst PRE-CREATION
> docs/src/site/sphinx/admin/Upgrade.rst PRE-CREATION
> docs/src/site/sphinx/conf.py 6a9bf31
> docs/src/site/sphinx/dev.rst PRE-CREATION
> docs/src/site/sphinx/dev/BuildingSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/dev/ClientAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/ConnectorDevelopment.rst PRE-CREATION
> docs/src/site/sphinx/dev/DevEnv.rst PRE-CREATION
> docs/src/site/sphinx/dev/RESTAPI.rst PRE-CREATION
> docs/src/site/sphinx/dev/Repository.rst PRE-CREATION
> docs/src/site/sphinx/index.rst a18fad2
> docs/src/site/sphinx/security.rst PRE-CREATION
> docs/src/site/sphinx/security/SecurityGuideOnSqoop2.rst PRE-CREATION
> docs/src/site/sphinx/user.rst PRE-CREATION
> docs/src/site/sphinx/user/CommandLineClient.rst PRE-CREATION
> docs/src/site/sphinx/user/Connectors.rst PRE-CREATION
> docs/src/site/sphinx/user/Sqoop5MinutesDemo.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-FTP.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-GenericJDBC.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-HDFS.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kafka.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-Kite.rst PRE-CREATION
> docs/src/site/sphinx/user/connectors/Connector-SFTP.rst PRE-CREATION
>
> Diff: https://reviews.apache.org/r/40393/diff/
>
>
> Testing
> -------
>
>
> Thanks,
>
> Jarek Cecho
>
>