Welcome to the open repository, documentation and materials for the Learning VIVO Development workshop at the VIVO 2018 Conference!
- When: Wednesday, June 6th, 2018, 8:30 AM - 11:30 AM
- Where: Meeting Room C
- Workshop Materials: github.com/j2blake/2018_dev_Workshop
- Workshop Code: Vitro and VIVO
- Workshop Slides: in this Repository
The goal of this workshop is to provide developers with a practical, hands-on introduction to selected VIVO development approaches and debugging methods. We also hope to highlight the process for contributing back to the VIVO core code. The workshop is intended to encourage further developer engagement in the VIVO community and to help begin training developers and build a broader base of VIVO committers. We ask that all participants come to the workshop ready to dive in by reviewing the information in this document. If you want a sneak peak of the workshop's contents, feel free to also watch this repository (you'll be notified of updates). To watch this repository, sign into GitHub, go this repository's home URL, and click the "Watch" button on the top right of the page.
| Time | Topic | Leader(s) |
|---|---|---|
| 8:30-8:40 AM | Overview and Introductions (10 minutes) | Whole Group |
| 8:40-9:10 AM | Set up your development environment (30 minutes) | Don |
| 9:10-9:20 AM | VIVO Architecture (10 minutes) | Jim |
| 9:20-9:45 AM | Deep dive: VIVO starts up (25 minutes) | Jim |
| 9:45-10:05 AM | Developing: Debugging VIVO in Eclipse (20 minutes) | Huda |
| 10:05-10:15 AM | Break (10 minutes) | n/a |
| 10:15-10:25 AM | Deep dive: Unit tests in VIVO (15 minutes) | Jim |
| 10:25-10:35 AM | Developing: The Developer Panel (10 minutes) | Jim |
| 10:35-10:45 AM | Deep dive: Search Index Configuration (10 minutes) | Jim |
| 10:45-11:05 AM | Developing: Search Index Configuration (20 minutes) | Huda |
| 11:05-11:30 AM | Developing: Pull Request process and interaction (25 minutes) | Andrew |
If you have questions or concerns leading up to or after the workshop, please open an issue on this GitHub repository, particularly with any questions dealing with workshop preparation or any installation issues. This allows multiple workshop leaders to respond as able, and other participants can also learn (since we're sure the same questions will come up multiple times): https://github.com/j2blake/2018_dev_Workshop/issues (this will require that you login or create a free account with GitHub).
During the workshop, we will indicate the best ways to get help or communicate a question/comment - however, this workshop is intended to be informal, so feel free to speak up or indicate you have a question at any time.
To keep this workshop a safe and inclusive space, we ask that you review and follow the Duraspace Code of Conduct and the Recurse Center Social Rules (aka Hacker School Rules).
To join VIVO slack, click here and join the dev-workshop channel.
We request that all participants:
- You should bring a laptop with a modern web browser and at least 4Gb memory (at we strongly recommend, if you want to play with more than intro data, at least 6Gb);
- Please have Vagrant and Virtual Machine downloaded per these instructions: installation instructions
If you have any issues with the above, please contact us ASAP using the communication methods detailed above.
- Virtual machine and Vagrant installation instructions
- Virtual machine/Vagrant on Mac OS - Google doc or in this repo
- Installation on Mac - Google doc or in this repo
- Installation on Windows - Google doc or in this repo
- We will be working with our copies of the Vitro and VIVO code using Vitro and VIVO respectively. For VIVO, checkout the branch "workshopBranch" as this will be the code we will walk through and debug together . The "functioningBranch" branch has the working version of the code that does not require any fixes and you can use that as a reference.