From 8d48e3c8a87701b856282394203706b1d612536c Mon Sep 17 00:00:00 2001 From: James Strachan Date: Thu, 8 Mar 2012 12:24:31 +0000 Subject: [PATCH] added some docs on how to deploy the API docs --- .../website/src/main/templates/developers.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 libraries/website/src/main/templates/developers.md diff --git a/libraries/website/src/main/templates/developers.md b/libraries/website/src/main/templates/developers.md new file mode 100644 index 00000000000..50447212c8d --- /dev/null +++ b/libraries/website/src/main/templates/developers.md @@ -0,0 +1,23 @@ +# Developer Notes + +## Regenerating the website + +To rebuild and generate the API docs, from a local checkout + + cd libraries + mvn install + +Now to be able to update the website you will need to add this to your **~/.m2/settings.xml** + +````xml + + github-project-site + git + +```` + +Now you can deploy the website via: + + cd website + mvn site:deploy +