Dear Wiki user, You have subscribed to a wiki page or wiki category on "Pig Wiki" for change notification.
The following page has been changed by CorinneC: http://wiki.apache.org/pig/HowToDocumentation ------------------------------------------------------------------------------ * site.xml â add or remove *.xml docs files here; controls which documents appear in the menu * tab.xml â add or remove tabs here; controls which tabs appear on each page + '''Note:''' Some *.xml files in the Pig user docs require the Forrest simplified Docbook plugin. In the forrest.properties file, the plugin entry has been updated to include the Docbook plugin: project.required.plugins=org.apache.forrest.plugin.output.pdf,org.apache.forrest.plugin.input.simplifiedDocbook == Updating the Pig Website Documentation == Checkout the site branch: https://svn.apache.org/repos/asf/hadoop/pig/site/ - To edit site doc files: + To edit website doc files: - * Change to the directory that contains the XML files: site/author/src/documentation/content/xdocs. + * Change to the directory that includes the *.xml files: site/author/src/documentation/content/xdocs. * Edit the existing files or add new files To view your edits using forrest: @@ -36, +37 @@ * Open a browser and enter http://localhost:8888/ - the /xdocs/index.xml page is displayed as index.html * Make more changes to the XML doc files and then refresh the browser display to see your changes. - To build the site doc using forrest: + To build the website doc using forrest: * Change to the directory that includes the forrest.properties file: site/author * Run the "forrest" command (if the build fails due to broken links, the *.html/*.pdf files will still be generated). * To check the *.html and *.pdf output, move to this output directory: /publish @@ -47, +48 @@ Checkout the trunk or relevant branch: http://svn.apache.org/repos/asf/hadoop/pig/trunk To edit the user doc files: - * Change to the directory that contains the XML files: /trunk/src/docs/src/documentation/content/xdocs + * Change to the directory that includes the *.xml files: /trunk/src/docs/src/documentation/content/xdocs * Edit the existing files or add new files To view your edits using forrest: @@ -59, +60 @@ To build the user docs using forrest: * Change to the directory that includes the forrest.properties file: /trunk/scr/docs * Run the "forrest" command (if the build fails due to broken links, the *.html/*.pdf files will still be generated). - * To check the *.html and *.pdf output, move to this output directory: /trunk/scr/docs/build/site + * To check the *.html and *.pdf output, move to this directory : /trunk/scr/docs/build/site To build the user docs using ant: * Change to the top directory of your structure: /trunk * Run the "ant docs" command - * To check the output, change to this directory: /trunk/docs + * To check the *.html and *.pdf output, change to this directory: /trunk/docs
