Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleYou first need to check out the contents as follows:
Code Block
$ svn co https://svn.apache.org/repos/asf/sqoop/site/trunk sqoopsite
$ cd sqoopsite
$ mvn site

Once done, you should be able to preview the site in your browser by pointing to /.../sqoopsite/target/site/index.html

Info
titleThis is only for updating the docs on the website. Once you have the contents checked out, you can modify them as needed:
  • From http://www.apache.org/dyn/closer.cgi/incubator/sqoop/, download the bin (e.g. sqoop-1.4.1-incubating__hadoop-0.20.tar.gz) and not the src (e.g. sqoop-1.4.1-incubating-src.tar.gz), which doesn't have the user and dev docs in HTML.
  • Strip out the 'man' dir from the 'docs' dir before uploading to the website.
  • Having a broken Sqoop logo in your local build (e.g. file:///Users/<username>/sqoopSite/site/target/site/index.html) is expected behavior.
  • Don't delete the old docs and bits in src/site/site.xml and src/site/xdoc/index.xml - just add in the new ones.
  • Don't forget to copy and paste in the release notes.
  • Note that if you aren't a Sqoop Committer, you'll need to file a JIRA to request a Committer deploy your changes. In your JIRA, be sure that docs.tar.gz is attached separately, which needs to go in site/src/site/resources. Also, you'll need to attach a patch of your changes, as shown below:
    Code Block
    cd /Users/<username>/sqoopSite/site
    svn update
    mvn clean
    svn diff > ~/sqoopSite/SQOOP-xyz.patch
    

...