a6b16f64eb627ea78ed256e45e5eb4f064693689
wiki/howto/onboarding.md
| ... | ... | @@ -2,24 +2,24 @@ |
| 2 | 2 | |
| 3 | 3 | This document describes the onboarding process for a new team member (developer) |
| 4 | 4 | |
| 5 | -First of all, make sure you've looked at http://www.amazon.de/Patterns-Elements-Reusable-Object-Oriented-Software/dp/0201633612. That's a great book, and knowing at least some of it will help you a great deal finding your way around our solution. |
|
| 5 | +First of all, make sure you've looked at [http://www.amazon.de/Patterns-Elements-Reusable-Object-Oriented-Software/dp/0201633612](http://www.amazon.de/Patterns-Elements-Reusable-Object-Oriented-Software/dp/0201633612). That's a great book, and knowing at least some of it will help you a great deal finding your way around our solution. |
|
| 6 | 6 | |
| 7 | 7 | ### Race Analysis Development Setup |
| 8 | 8 | |
| 9 | 9 | #### Installations |
| 10 | 10 | |
| 11 | -1. Eclipse (Eclipse IDE for Eclipse Committers, version 4.7.2 ["Oxygen SR2"](http://www.eclipse.org/downloads/packages/eclipse-ide-eclipse-committers/oxygen2)), http://www.eclipse.org |
|
| 11 | +1. Eclipse (Eclipse IDE for Eclipse Committers, version 4.7.2 ["Oxygen SR2"](http://www.eclipse.org/downloads/packages/eclipse-ide-eclipse-committers/oxygen2)), [http://www.eclipse.org](http://www.eclipse.org) |
|
| 12 | 12 | 2. Eclipse Extensions |
| 13 | - * Install GWT Eclipse plugin for Eclipse (https://github.com/gwt-plugins/gwt-eclipse-plugin using http://storage.googleapis.com/gwt-eclipse-plugin/v3/release as the update site URL) |
|
| 14 | - * Install Eclipse debugger for GWT SuperDevMode (master version: http://p2.sapsailing.com/p2/sdbg; public release: http://sdbg.github.io/p2) |
|
| 15 | -3. Git (e.g. Git for Windows v2.12.2), http://git-scm.com / https://git-for-windows.github.io/ |
|
| 16 | -4. MongoDB (e.g. Production Release 2.6.7), download: https://www.mongodb.com/ |
|
| 17 | -5. RabbitMQ, download from http://www.rabbitmq.com/. Requires Erlang to be installed. RabbitMQ installer will assist in installing Erlang. Some sources report that there may be trouble with latest versions of RabbitMQ. In some cases, McAffee seems to block the installation of the latest version on SAP hardware; in other cases connection problems to newest versions have been reported. We know that version 3.6.8 works well. https://github.com/rabbitmq/rabbitmq-server/releases/tag/rabbitmq_v3_6_8 is the link. |
|
| 18 | -6. JDK 1.7 (Java SE 7), http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html |
|
| 19 | -7. JDK 1.8 (Java SE 8), http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html |
|
| 20 | -8. Maven 3.1.1 (or higher), http://maven.apache.org |
|
| 21 | -9. GWT SDK 2.8.2 (http://www.gwtproject.org/download.html) |
|
| 22 | -10. Standalone Android SDK (see section "Additional steps required for Android projects"). OPTIONALLY: You may additionally install Android Studio (https://developer.android.com/tools/studio/index.html) or IntelliJ IDEA (https://www.jetbrains.com/idea/download/). |
|
| 13 | + * Install GWT Eclipse plugin for Eclipse ([https://github.com/gwt-plugins/gwt-eclipse-plugin](https://github.com/gwt-plugins/gwt-eclipse-plugin) using [http://storage.googleapis.com/gwt-eclipse-plugin/v3/release](http://storage.googleapis.com/gwt-eclipse-plugin/v3/release) as the update site URL) |
|
| 14 | + * Install Eclipse debugger for GWT SuperDevMode (master version: [http://p2.sapsailing.com/p2/sdbg](http://p2.sapsailing.com/p2/sdbg); public release: [http://sdbg.github.io/p2](http://sdbg.github.io/p2)) |
|
| 15 | +3. Git (e.g. Git for Windows v2.12.2), [http://git-scm.com](http://git-scm.com) / [https://git-for-windows.github.io](https://git-for-windows.github.io) |
|
| 16 | +4. MongoDB (e.g. Production Release 2.6.7), download: [https://www.mongodb.com/](https://www.mongodb.com/) |
|
| 17 | +5. RabbitMQ, download from [http://www.rabbitmq.com](http://www.rabbitmq.com). Requires Erlang to be installed. RabbitMQ installer will assist in installing Erlang. Some sources report that there may be trouble with latest versions of RabbitMQ. In some cases, McAffee seems to block the installation of the latest version on SAP hardware; in other cases connection problems to newest versions have been reported. We know that version 3.6.8 works well. [https://github.com/rabbitmq/rabbitmq-server/releases/tag/rabbitmq_v3_6_8](https://github.com/rabbitmq/rabbitmq-server/releases/tag/rabbitmq_v3_6_8) is the link. |
|
| 18 | +6. JDK 1.7 (Java SE 7), [http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html) |
|
| 19 | +7. JDK 1.8 (Java SE 8), [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) |
|
| 20 | +8. Maven 3.1.1 (or higher), [http://maven.apache.org](http://maven.apache.org) |
|
| 21 | +9. GWT SDK 2.8.2 ([http://www.gwtproject.org/download.html](http://www.gwtproject.org/download.html)) |
|
| 22 | +10. Standalone Android SDK (see section "Additional steps required for Android projects"). OPTIONALLY: You may additionally install Android Studio ([https://developer.android.com/tools/studio/index.html](https://developer.android.com/tools/studio/index.html)) or IntelliJ IDEA ([https://www.jetbrains.com/idea/download/](https://www.jetbrains.com/idea/download/)). |
|
| 23 | 23 | |
| 24 | 24 | #### Automatic Eclipse plugin installation |
| 25 | 25 | |
| ... | ... | @@ -37,7 +37,7 @@ Be aware hat the installation may take several minutes depending on your Interne |
| 37 | 37 | |
| 38 | 38 | #### Further optional but recommended installations |
| 39 | 39 | |
| 40 | -1. Cygwin, http://www.cygwin.com/ |
|
| 40 | +1. Cygwin, [http://www.cygwin.com/](http://www.cygwin.com/) |
|
| 41 | 41 | 2. Eclipse Mylyn Bugzilla extension |
| 42 | 42 | 3. kdiff3 (git tool) |
| 43 | 43 | 4. Firebug (javascript & .css debugging, included in Firefox Developer Tools in newer versions of Firefox by default) |
| ... | ... | @@ -46,13 +46,13 @@ Be aware hat the installation may take several minutes depending on your Interne |
| 46 | 46 | |
| 47 | 47 | 1. Git Account |
| 48 | 48 | The primary Git repository for the project is hosted on sapsailing.com. It is mirrored on an hourly basis into SAP's internal Git/Gerrit repository, but branches from the external Git end up under the remote ``sapsailing.com`` in the internal repository, thus do not automatically merge into their branch counterparts. Conversely, commits pushed onto branches of the SAP-internal Gerrit will not by themselves end up on the external Git at sapsailing.com. |
| 49 | - * For access to the external git at ssh://trac@sapsailing.com/home/trac/git please send your SSH public key to Axel Uhl or Simon Marcel Pamies, requesting git access. Make sure to NOT generate the key using Putty. Putty keys don't work reliably under Linux and on Windows/Cygwin environments. Use ssh-keygen in a Cygwin or Linux or MacOS/X environment instead. |
|
| 50 | - * Alternatively, for access to the SAP-internal Git/Gerrit repository register yourself as a Git user in the SAP-Git under: https://git.wdf.sap.corp:8080/; ask the Git administrator (Axel Uhl) to get on the list of enabled committers |
|
| 49 | + * For access to the external git at ``ssh://trac@sapsailing.com/home/trac/git`` please send your SSH public key to Axel Uhl or Simon Marcel Pamies, requesting git access. Make sure to NOT generate the key using Putty. Putty keys don't work reliably under Linux and on Windows/Cygwin environments. Use ssh-keygen in a Cygwin or Linux or MacOS/X environment instead. |
|
| 50 | + * Alternatively, for access to the SAP-internal Git/Gerrit repository register yourself as a Git user in the SAP-Git under: [https://git.wdf.sap.corp:8080/](https://git.wdf.sap.corp:8080/); ask the Git administrator (Axel Uhl) to get on the list of enabled committers |
|
| 51 | 51 | 2. Bugzilla |
| 52 | 52 | * Ask the Bugzilla administrator (Frank Mittag, Axel Uhl) to create a bugzilla account for you. |
| 53 | - * Bugzilla url: http://bugzilla.sapsailing.com/bugzilla/ |
|
| 53 | + * Bugzilla url: [http://bugzilla.sapsailing.com/bugzilla/](http://bugzilla.sapsailing.com/bugzilla/) |
|
| 54 | 54 | 3. Wiki |
| 55 | - * Send a request to Axel Uhl or Simon Marcel Pamies that includes the SHA1 hash of your desired password. Obtain such an SHA1 hash for your password here: http://www.sha1-online.com/. |
|
| 55 | + * Send a request to Axel Uhl or Simon Marcel Pamies that includes the SHA1 hash of your desired password. Obtain such an SHA1 hash for your password here: [http://www.sha1-online.com/](http://www.sha1-online.com/). |
|
| 56 | 56 | 4. Hudson |
| 57 | 57 | * Request a Hudson user by sending e-mail to Axel Uhl, Frank Mittag or Simon Marcel Pamies. |
| 58 | 58 | |
| ... | ... | @@ -61,7 +61,7 @@ The primary Git repository for the project is hosted on sapsailing.com. It is mi |
| 61 | 61 | 1. Get the content of the git repository |
| 62 | 62 | * Generate SSH Keys with "ssh-keygen -t rsa -C "" " command in Cygwin Terminal (Not with Putty!!!) |
| 63 | 63 | * Clone the repository to your local file system from `ssh://[SAP-User]@git.wdf.sap.corp:29418/SAPSail/sapsailingcapture.git` or `ssh://[user]@sapsailing.com/home/trac/git` User "trac" has all public ssh keys. |
| 64 | - * Please note that when using one of the newer versions of Cygwin, your Cygwin home folder setting might differ from your Windows home folder. This will likely lead to problems when issuing certain commands. For troubleshooting, take a look at the following thread: https://stackoverflow.com/questions/1494658/how-can-i-change-my-cygwin-home-folder-after-installation |
|
| 64 | + * Please note that when using one of the newer versions of Cygwin, your Cygwin home folder setting might differ from your Windows home folder. This will likely lead to problems when issuing certain commands. For troubleshooting, take a look at the following thread: [https://stackoverflow.com/questions/1494658/how-can-i-change-my-cygwin-home-folder-after-installation](https://stackoverflow.com/questions/1494658/how-can-i-change-my-cygwin-home-folder-after-installation) |
|
| 65 | 65 | 2. Check out the 'master' branch from the git repository. The 'master' branch is the main development branch. Please check that you start your work on this branch. |
| 66 | 66 | 3. Setup and configure Eclipse |
| 67 | 67 | * Make absolutely sure to import CodeFormatter.xml (from $GIT_HOME/java) into your Eclipse preferences (Preferences->Java->Code Style->Formatter) |
| ... | ... | @@ -92,10 +92,10 @@ The primary Git repository for the project is hosted on sapsailing.com. It is mi |
| 92 | 92 | * Run "SailingGWT sdm" in the debug dropdown |
| 93 | 93 | 5. Import races within the Race Analysis Suite |
| 94 | 94 | * <del>Choose "Security UI sdm" in the upper left corner of the "Development Mode" Tab in Eclipse and open "...Login.html" in your browser</del> (obsolete) |
| 95 | - * Choose "SailingGWT sdm" in the "Development Mode" Tab and open "...AdminConsole.html..." (It is normal that the first try fails. Reload the page after the first try) |
|
| 95 | + * Choose "GWT Sailing SDM" in the "Development Mode" Tab and open "...AdminConsole.html..." (It is normal that the first try fails. Reload the page after the first try) |
|
| 96 | 96 | * Default Login: user "admin", password "admin" |
| 97 | 97 | * In the list on the left, click on "Connectors" |
| 98 | - * For TracTrac Events: In the "TracTrac Connections" Form, fill in the JSON URL http://germanmaster.traclive.dk/events/event_20120905_erEuropean/jsonservice.php (all other required information will be filled in automatically) |
|
| 98 | + * For TracTrac Events: In the "TracTrac Connections" Form, fill in the JSON URL [http://germanmaster.traclive.dk/events/event_20120905_erEuropean/jsonservice.php](http://germanmaster.traclive.dk/events/event_20120905_erEuropean/jsonservice.php)(all other required information will be filled in automatically) |
|
| 99 | 99 | * Press "List Races" |
| 100 | 100 | |
| 101 | 101 | #### Git repository configuration essentials |
| ... | ... | @@ -130,10 +130,10 @@ When a file has "wrong line endings" (line endings are different to what is conf |
| 130 | 130 | To ensure that all components of the Analysis Suite are working, you should also import all Android projects (mobile/) into your workspace. There are some additional requirements to enable the build process of these projects. |
| 131 | 131 | |
| 132 | 132 | 1. Add the Android Development Tools (ADT) plugin to your Eclipse IDE |
| 133 | - - In Eclipse click Help -> Install New Software -> Add and enter https://dl-ssl.google.com/android/eclipse/ |
|
| 133 | + - In Eclipse click Help -> Install New Software -> Add and enter [https://dl-ssl.google.com/android/eclipse/](https://dl-ssl.google.com/android/eclipse/) |
|
| 134 | 134 | - Select the Developer Tools and install |
| 135 | 135 | - After restarting Eclipse the "Welcome to Android Development"-window should help you with installing the Android SDK |
| 136 | - - It is also possible to download the Android SDK separately from the official Google download website. However, as of Revision 25.0.0 of the Android SDK Tools, the SDK Manager became an integrated part of Android Studio. Therefore, Revisions newer than 24.4.1 will not come with a standalone SDK Manager. Since it is absolutely essential if you want to use Eclipse, please download the Android SDK from the following link: https://dl.google.com/android/installer_r24.4.1-windows.exe |
|
| 136 | + - It is also possible to download the Android SDK separately from the official Google download website. However, as of Revision 25.0.0 of the Android SDK Tools, the SDK Manager became an integrated part of Android Studio. Therefore, Revisions newer than 24.4.1 will not come with a standalone SDK Manager. Since it is absolutely essential if you want to use Eclipse, please download the Android SDK from the following link: [https://dl.google.com/android/installer_r24.4.1-windows.exe](https://dl.google.com/android/installer_r24.4.1-windows.exe) |
|
| 137 | 137 | 2. Setup the Android SDK |
| 138 | 138 | * In Eclipse press Window -> Android SDK Manager |
| 139 | 139 | * Install everything of "Tools" |