What
The primary objective of the i18n sprints are to bring the language-aware editing capabilities into the core VIVO application.
This objective will include the following goals:
- Creation of Integration and Regression tests to ensure the existing functionality does not break during the course of the i18n editing development activities (and beyond)
- Transfer of UQAM software updates into one or more GitHub repositories
- Review, testing and integration of the initial UQAM software updates into core VIVO
- Given the size of these initial software updates, we will need to slice the updates into smaller units of functionality and pull-requests
- Establishment of a pattern for making additional languages available to all VIVO installations
- Review and test incremental i18n editing updates
- Update documentation of installation and configuration guides
When
Four Three sprints are planned:
- April 6 - 17
- May 19 - 25 (Tuesday through following Monday)
- June 22 - July 3 (sprints 3 and 4 combined)
Who (and roles)
Roles: developer, documenter, tester, translator, other?
- Michel Héon(UQAM) Developer
- Joachim Dornbusch (EHESS)
- Christian Hauschke (TIB; check German version pages, documentation)
- Benjamin Gross (limited availability, testing and code review)
- Ralph O'Flinn (limited availability, testing and code review)
- Alexander (Sacha) Jerabek(UQAM - review documentation, check French version pages, test installation of Vivo)
- Matthias Lühr(HS Mittweida; testing, documentation)
- Andrew Woods Developer / Tester
- Nicolas Dickner(UQAM - review documentation, check French version pages, test installation of Vivo)
- Rachid Belkouch (UQAM - review documentation, check French version pages, help coordinate if necessary)
Sprint Summary
The (current) i18n sprint officially ended on Friday, April 17th.
The team consisted of ten participants from 6 different organizations.
The top-level objective of the effort is to establish a clearly documented capability within VIVO to add new and enable existing languages such that both the static text as well as the site-specific data is exposed in a language-aware context. Additionally, the effort is focused on adding the ability to create language-aware content in the native VIVO user interface.
In addition to establishing a cohesive and productive team, the primary outcomes of the sprint include:
- Initial (pre-beta) implementation of i18n edit capabilities, found on the "sprint-i18n" branches of the VIVO, Vitro, VIVO-languages and Vitro-languages projects
- Comprehensive testing of the i18n implementation across (almost) all UI pages, and associated JIRA ticket creation
- 63 JIRA bug tickets created (14 resolved)
- 6 JIRA improvement tickets created (4 resolved)
- 4 JIRA test tickets created
- 4 JIRA documentation tickets created
- Selenium testing framework created with a focus on i18n
- Git / GitHub process documentation created to help onboard team members to the VIVO development processes
Remaining tasks include:
- Finish testing of remaining few UI pages
- Resolving and verifying fixes of identified bugs
- Documentation of how to use the updated functionality, how to enable languages, and how to add a new language
- Expanding Selenium tests
- Code refactoring
In order to complete the outstanding tasks, we will be holding one-week-long sprints during the months of May, June and July. Mark you calendars! These sprints will be happening on the third full week of the month:
- May 18-22
- June 15-19
- July 20-24
Resources
Description | Resources |
---|---|
1) Project wiki | |
2) UQAM's GitHub | https://github.com/UQAM-VIVO/ - although development will happen on the 'sprint-i18n' branches of VIVO/Vitro/VIVO-languages/Vitro-languages |
3) Test data | https://github.com/UQAM-VIVO/VTE-config/tree/master/Data
|
4) i18n Reference Demo Demo VIVO server consisting of UQAM's implementation of the i18n editor design | http://vivo-i18n.dev.uqam.ca:8080/vivo_i18n_M2/
|
5) Vivo Translation Ecosystem Ecosystem useful for the development of VIVO
| http://vivo-i18n.dev.uqam.ca:8080/download/VIVO-Trad-ecosysteme.exe |
6) VTE First run wiki Documentation in under construction | https://wiki.uqam.ca/display/VIVOPUB/C%29+Local+VIVO+implementation%3A+from+scrach+to+execution+with+VTE |
Sprint goals
Updates will go into the core
Sprint will demonstrate editing with French, German and English
Regression testing with Selenium
Updated documentation
Sprint prerequisites
- Code in GitHub
- GitHub diff/pr
- Remove whitespace from VIVO and Vitro working branches
- How can the code be subdivided? - no, the plan is to refine the sprint branches, then submit uber-PR
- Test data
- Set up a reporting and monitoring tool for identified problems (potentially Jira) able to manage screenshots - JIRA scrum board
Future goals
- English to be extracted, like any other language
- All VIVO languages will be consolidated into central language repositories
- Move translation files to ontology files
Working GitHub branches
- VIVO : https://github.com/vivo-project/VIVO/tree/sprint-i18n-whitespace (until we have whitespace removed)
- Vitro : https://github.com/vivo-project/Vitro/tree/sprint-i18n-whitespace (until we have whitespace removed)
- VIVO-languages : https://github.com/vivo-project/VIVO-languages/tree/sprint-i18n
- Vitro-languages : https://github.com/vivo-project/Vitro-languages/tree/sprint-i18n