The sprint notes from the PKP Hannover Sprint, hosted by the Leibniz Information Centre for Science and Technology in September 2023 are now available.
Sprints involve PKP community members joining diverse groups to work on PKP software and support. The Leibniz Information Centre for Science and Technology (TIB) hosted six working groups at the PKP Hannover Sprint in September. This is a summary of one such group’s work.
Group members
- Mariya Maistrovskaya, PKP
- Sebastian Schmidt, SLUB Dresden
- Oliver Krüger, Staats- und Universitätsbibliothek Hamburg
- Touhidur Rahman, PKP
- Alejandra Casas Niño De Rivera, PKP
- Tom Granroth, Federation of Finnish Learned Societies
- Patricia Mangahis, PKP
- Philip Münch, UB Osnabrück
Documentation work topics
- Documentation Categorization
- Markdown
- Recurring DIG tasks
Documentation Categorization
- Used the categorization spreadsheet suggested by the Spanish DIG
- Defined categories, subcategories, document types, target audiences, and topic tags
- Clean spreadsheet (removing duplicates, rearranging columns)
- Used them to categorize 24 documents
Next steps:
Finish Categorization. Categorization is to be discussed with the DIG.
Markdown
- Sandbox mode: Filed. https://github.com/pkp/pkp-lib/issues/9296
- Showing potentially unavailable plugins during upgrade:
- https://github.com/pkp/plugin-gallery/blob/main/plugins.xml
- Touhidur to file.
- Filed at https://github.com/pkp/pkp-lib/issues/9297
- Adding information about old versions to the plugin compatibility list:
- Current list: https://pkp.github.io/plugin-compatibility/index.html
- How it’s generated: https://github.com/pkp/plugin-gallery/blob/main/.travis.yml
- JS tool: https://github.com/pkp/pkp-plugin-cli
- JS-Template:https://github.com/pkp/pkp-plugin-cli/blob/main/src/generate-site/template.mustache
- Filed PR at https://github.com/pkp/pkp-plugin-cli/pull/6
- Branch documentation for developers
- HackMD: https://hackmd.io/@EvYOkD3HSsGEgGgyCu6Wjw/rJrOkCpRn/edit
- Committed to docs hub main.
- How to document hooks
- We are using Doxygen but would like to move to phpDocumentor.
- We could create a custom tag in phpDocumentor: https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/examples/04-adding-your-own-tag.php
DIG Tasks
- 3.4 screenshot updates
- PR submitted for 2 sections of the Learning OJS guide, progress tracked in a new tab of the DIG task spreadsheet
