doc on workspace and dev tool in read the docs 61/22261/1
authorseshukm <seshu.kumar.m@huawei.com>
Mon, 6 Nov 2017 06:59:57 +0000 (12:29 +0530)
committerseshukm <seshu.kumar.m@huawei.com>
Mon, 6 Nov 2017 06:59:57 +0000 (12:29 +0530)
IssueId: SO-300

Change-Id: I2ce700118bb06d87931fc48b3c1cf2af5829700a
Signed-off-by: seshukm <seshu.kumar.m@huawei.com>
docs/Workspace_and_Development_Tools.rst [new file with mode: 0644]

diff --git a/docs/Workspace_and_Development_Tools.rst b/docs/Workspace_and_Development_Tools.rst
new file mode 100644 (file)
index 0000000..2012a20
--- /dev/null
@@ -0,0 +1,107 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+.. Copyright 2017 Huawei Technologies Co., Ltd.\r
+\r
+Workspace and Development Tools\r
+===============================\r
+\r
+We recognize that there are different ways to set up a workspace and different tools that may be chosen.  This is just one way to set things up.\r
+\r
+Suggested Directory Structure\r
+------------------------------\r
+*NOTE*: You may have different versions of eclipse and java.\r
+\r
+       onap\r
+       \r
+               .m2\r
+               \r
+               apache-maven-3.3.9\r
+               \r
+               camunda-modeler\r
+               \r
+               eclipse-jee-neon-3-linux-gtk-x86_64\r
+               \r
+               jdk1.8.0_131\r
+               \r
+               workspace\r
+               \r
+                       SO\r
+                               chef-repo\r
+                               \r
+                               docker-config\r
+                               \r
+                               libs\r
+                               \r
+                               so\r
+                               \r
+                               so-config\r
+                               \r
+Java\r
+-----\r
+Download the latest Java_8_SE_Development_Kit_ from Oracle.   Select a Linux x64 package.\r
+\r
+Unpack it.\r
+\r
+.. _Java_8_SE_Development_Kit: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html\r
+\r
+Maven\r
+------\r
+\r
+Download the Apache_Maven_3.3.9_ binary.  NOTE: 3.3.9 is the recommended version, even though much higher versions are available.\r
+\r
+Unpack it.\r
+\r
+.. _Apache_Maven_3.3.9: https://archive.apache.org/dist/maven/maven-3/3.3.9/binaries/\r
+\r
+Create an .m2 directory for maven and put settings.xml_ in it.  Edit the local repository path in settings.xml to make it correct for your environment.  Everything else should be OK.\r
+\r
+.. _settings.xml: https://wiki.onap.org/download/attachments/15997820/settings.xml?version=1&modificationDate=1506156303000&api=v2\r
+\r
+Camunda Modeler\r
+---------------\r
+\r
+Download the Camunda_Modeler_.  Select the Linux x64 package.\r
+Unpack it.\r
+\r
+.. _Camunda_Modeler: https://camunda.org/download/modeler/\r
+\r
+Eclipse\r
+-------\r
+\r
+Download Eclipse_for_Linux_.  Select the 64-bit Eclipse IDE for Java EE Developers.  Oxygen seems to be the latest version. These instructions were written for Neon.\r
+Unpack it.\r
+\r
+.. _Eclipse_for_Linux:  https://www.eclipse.org/downloads/eclipse-packages/?osType=linux\r
+\r
+In the eclipse directory, edit eclipse.ini\r
+\r
+       Add (or change) the -vm setting so that it points to your JDK.\r
+       \r
+       Adjust the maximum heap space (2GB is recommended).\r
+       \r
+       Example:\r
+       \r
+.. image:: images/Workspace_and_Development_Tools.png  \r
+       \r
+Eclipse Settings\r
+----------------\r
+\r
+**Configure eclipse to use your external maven 3.3.9 installation:**\r
+       Go to Window→Preferences→Maven→Installations\r
+       \r
+       Click "Add" and browse to your apache-maven-3.3.9 directory.  Click "OK" to select it.\r
+       \r
+       Click "Finish"\r
+       \r
+.. image:: images/Workspace_and_Development_Tools_2.png\r
+\r
+Make sure the external installation is selected:\r
+\r
+.. image:: images/Workspace_and_Development_Tools_3.png\r
+\r
+**Configure eclipse to use your settings.xml**\r
+       Go to Window→Preferences→Maven→User Settings\r
+       \r
+       Type the full path to your settings.xml file into the "User Settings" box and click "OK".\r
+       \r
+.. image:: images/Workspace_and_Development_Tools_4.png
\ No newline at end of file