fd6e34fdb2338d0dab8bfdefc012f9306f45e754
wiki/howto/onboarding.md
| ... | ... | @@ -10,7 +10,9 @@ First of all, make sure you've looked at [http://www.amazon.de/Patterns-Elements |
| 10 | 10 | |
| 11 | 11 | 1. Git Account |
| 12 | 12 | |
| 13 | - - The primary Git repository for the project is hosted on Github (see [https://github.com/SAP/sailing-analytics](https://github.com/SAP/sailing-analytics)). To clone, use ``git@github.com:SAP/sailing-analytics.git``. To gain write access you have to become member of the [sailing-analytics-team](https://github.com/orgs/SAP/teams/sailing-analytics-team) organization. For that you need to [link your Github user to the Github SAP organization](https://wiki.one.int.sap/wiki/display/ospodocs/Self-Service+for+Joining+an+SAP+GitHub+Organization). For that to work, your Github account needs to have your @sap.com e-mail address assigned and verified. We still have a shadow repository around that, e.g., powers our Wiki at [https://wiki.sapsailing.com](https://wiki.sapsailing.com) and which lives at ``ssh://trac@sapsailing.com/home/trac/git``. |
|
| 13 | + - The primary Git repository for the project is hosted on Github (see [https://github.com/SAP/sailing-analytics](https://github.com/SAP/sailing-analytics)). To clone, use ``git@github.com:SAP/sailing-analytics.git``. |
|
| 14 | + - If you are on Windows, keep in mind you may run into the following problem. By default, the filesystem in Windows enforces a 260 character limit on paths. The longest path length for a file in this project, if the drive name is included, is 263 characters. A possible solution is to pass a single character name for the project folder in the git clone command, and clone the project on drive root, which may bring the longest file path down to compatible length. Alternatively, Windows 10 and 11 offer settings to enable a much much longer maximum file path that requires additional configuration. You may check that out at your own will. |
|
| 15 | + - To gain write access you have to become member of the [sailing-analytics-team](https://github.com/orgs/SAP/teams/sailing-analytics-team) organization. For that you need to [link your Github user to the Github SAP organization](https://wiki.one.int.sap/wiki/display/ospodocs/Self-Service+for+Joining+an+SAP+GitHub+Organization). For that to work, your Github account needs to have your @sap.com e-mail address assigned and verified. We still have a shadow repository around that, e.g., powers our Wiki at [https://wiki.sapsailing.com](https://wiki.sapsailing.com) and which lives at ``ssh://trac@sapsailing.com/home/trac/git``. |
|
| 14 | 16 | |
| 15 | 17 | - In case you'd like to get access to the external git at `ssh://trac@sapsailing.com/home/trac/git` please send your SSH public key to one of the project maintainers, 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. For further instructions for generating an ssh-key see [GitHub](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). |
| 16 | 18 | Note: If you want to use the ssh-key in the context of our solution, it can be an RSA or ED25519 format. Example for creating a key: `ssh-keygen -t ed25519 -b 512 -C "test@test.com"`. Make sure to set a non-empty password for your key. |
| ... | ... | @@ -125,17 +127,16 @@ Go to Window ⇒ Preferences and change the following two settings: |
| 125 | 127 | ### Steps to build and run the Sailing Analytics |
| 126 | 128 | |
| 127 | 129 | 1. Check out the ``main`` branch from the git repository. The ``main`` branch is the main development branch. Please check that you start your work based on this branch. |
| 128 | -2. If you are on Windows, keep in mind you may run into the following problem. By default, the filesystem in Windows enforces a 260 character limit on paths. The longest path length for a file in this project, if the drive name is included, is 263 characters. A possible solution is to pass a single character name for the project folder in the git clone command, and clone the project on drive root, which may bring the longest file path down to compatible length. Alternatively, Windows 10 and 11 offer settings to enable a much much longer maximum file path that requires additional configuration. You may check that out at your own will. |
|
| 129 | -3. Setup and configure Eclipse |
|
| 130 | +2. Setup and configure Eclipse |
|
| 130 | 131 | - Import all Race Analysis projects from the `java/` subdirectory of the git main folder (make sure to import via the wizard [but without smart import] "Import ⇒ General ⇒ Projects from Folder or Archive" in Eclipse, and additionally make sure to scan for nested projects!) |
| 131 | 132 | - In "Window ⇒ Preferences ⇒ Plug-in Development ⇒ Target Platform" set the Eclipse target platform to `Race Analysis Target` (located in com.sap.sailing.targetplatform/definitions//race-analysis-p2-remote.target) |
| 132 | 133 | - Wait until the target platform has been resolved completely |
| 133 | 134 | - Start a clean build (Project ⇒ Clean) |
| 134 | -4. To get a clean workspace, additional steps should be performed once: |
|
| 135 | +3. To get a clean workspace, additional steps should be performed once: |
|
| 135 | 136 | 1. Run "GWT Dashboards SDM" launch configuration. After successful start, launch configuration can be stopped. |
| 136 | 137 | 2. Run "GWT Security SDM" launch configuration. After successful start, launch configuration can be stopped. |
| 137 | 138 | 3. Run "GWT xdStorage Sample SDM" launch configuration. After successful start, launch configuration can be stopped. |
| 138 | -5. Run the Race Analysis Suite |
|
| 139 | +4. Run the Race Analysis Suite |
|
| 139 | 140 | 1. Ensure your local MongoDB Server is running; depending on your platform, maybe you can start your MongoDB using ``sudo systemctl start mongod``, or you may have to do something like: |
| 140 | 141 | 1. Create a folder for the mongoDB to store the data. For existing folders make sure they do not contain a `mongod.lock` file |
| 141 | 142 | 2. Open a terminal and navigate to the location of the MongoDB installation `cd /somePathTo MongoDBInstallation/mongodb/bin` |
| ... | ... | @@ -143,13 +144,13 @@ Go to Window ⇒ Preferences and change the following two settings: |
| 143 | 144 | `./mongod --dbpath /somePathTo/MongoDBDataDirectory` |
| 144 | 145 | 2. Run "GWT Sailing SDM" in the debug dropdown |
| 145 | 146 | 3. Start the appropriate Eclipse back-end launch configuration (in most cases 'Sailing Server (no Proxy)'). You´ll find this in the debug dropdown. |
| 146 | -6. Import races within the Race Analysis Suite |
|
| 147 | +5. Import races within the Race Analysis Suite |
|
| 147 | 148 | - Choose "GWT Sailing SDM" in the "Development Mode" Tab and open "...AdminConsole.html...". This should open [http://127.0.0.1:8888/gwt/AdminConsole](http://127.0.0.1:8888/gwt/AdminConsole). (It is normal that the first try fails. Reload the page after the first try) |
| 148 | 149 | - Default Login: user "admin", password "admin" |
| 149 | 150 | - In the list on the left, click on "Connectors" |
| 150 | 151 | - 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) |
| 151 | 152 | - Press "List Races" |
| 152 | -7. Further useful launch configurations |
|
| 153 | +6. Further useful launch configurations |
|
| 153 | 154 | - Use SAP JVM Profiler. If you used the script above and installed the SAPJVM instead of the jdk, you can now open the profiling perspective by clicking on Window ⇒ Perspective ⇒ Open Perspective ⇒ Profiling) |
| 154 | 155 | - Debugging gwt: For further instructions please see [here](./development/super-dev-mode) |
| 155 | 156 |