About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » community » pmc_meetings » minutes20230213
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
community:pmc_meetings:minutes20230213

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
community:pmc_meetings:minutes20230213 [2023/02/13 15:53] – [Other Items] demiankatzcommunity:pmc_meetings:minutes20230213 [2023/03/13 13:35] (current) – [8. Fundraising Communication Plan] demiankatz
Line 3: Line 3:
 Attending: Anne Christensen, Chris Hallberg, Demian Katz, André Lahmann, Ere Maijala, David Maus, Mohan Raj Pradhan Attending: Anne Christensen, Chris Hallberg, Demian Katz, André Lahmann, Ere Maijala, David Maus, Mohan Raj Pradhan
  
-Apologies: Oliver Goldschmidt, Leila Gonzales, Craig Murdoch +Apologies: Oliver Goldschmidt, Leila Gonzales, Craig Murdoch, Leander Seige
- +
-:!: This document currently serves as an agenda but will be converted to minutes following the meeting.+
  
 ===== 1. Review of Action Items from Previous Meeting ===== ===== 1. Review of Action Items from Previous Meeting =====
Line 27: Line 25:
   * The newsletter should clarify which future release(s) will include completed work. Demian will start doing this going forward.   * The newsletter should clarify which future release(s) will include completed work. Demian will start doing this going forward.
   * No one seems to use or care about the autogenerated PHPDocumentor documentation, and there were complaints about the verbosity of the comments that power it (though comments were generally regarded as useful/valuable). This points to the possibility of reviewing our PHP_CodeSniffer rules and possibly changing the way we approach PHPDoc comments, since this has not been reviewed or changed in over a decade, and PHP has significantly evolved (e.g. with typehints built into the language which render many doc comments redundant).   * No one seems to use or care about the autogenerated PHPDocumentor documentation, and there were complaints about the verbosity of the comments that power it (though comments were generally regarded as useful/valuable). This points to the possibility of reviewing our PHP_CodeSniffer rules and possibly changing the way we approach PHPDoc comments, since this has not been reviewed or changed in over a decade, and PHP has significantly evolved (e.g. with typehints built into the language which render many doc comments redundant).
-    * David/Ere agreed that there's room for improvement here. More typehints, fewer redundant docblocks. Better hints about exceptions needed. Perhaps allow lines longer than 80 characters. Need new tooling -- one starting point: enforce typehints via phpstan. PHP 8 also allows for better typing than PHP 7 and may further reduce the redundancy. Challenge: adding types will impact downstream code. Challenge: introducing types can introduce bugs; more tests may be needed. VuFind 10 might be a good target for a large type-related project. Can we tag different files in VuFind to have different PHP_CodeSniffer rules applied so that we can begin a gradual transition?+    * David/Ere agreed that there's room for improvement here. More typehints, fewer redundant docblocks. Better hints about exceptions needed. Perhaps allow lines longer than 80 characters. Need new tooling -- one starting point: enforce typehints via phpstan. PHP 8 also allows for better typing than PHP 7 and may further reduce the redundancy. Challenge: adding types will impact downstream code. Challenge: introducing types can introduce bugs; more tests may be needed. VuFind 10 might be a good target for a large type-related project. David asked, can we tag different files in VuFind to have different PHP_CodeSniffer rules applied so that we can begin a gradual transition?
   * References to older versions cause some confusion, and raise concerns about documentation being out of date. Should we remove or rephrase this for versions before a particular threshold?   * References to older versions cause some confusion, and raise concerns about documentation being out of date. Should we remove or rephrase this for versions before a particular threshold?
     * Ere asked whether we need version-specific pages in some cases? Can we use a struct plugin to control this in a more structured way? André asked if we should consider snapshotting versions of the wiki at points in time to refer to specific versions? (If so, how do we document upcoming features?). Alternative proposal from Demian: simply state that documentation should be accurate for some number of recent VuFind releases (e.g. latest 2-3 major releases). Older notes could be removed. Since VuFind is designed to be fairly evergreen, this might be a more maintainable solution, and encourage people to upgrade from very old versions while still leaving likelihood of most documentation still applying to older versions. Mohan highlighted the need to upgrade documentation relating to VuFind's integration with third-party systems, since these also change frequently and may require documentation updates. Ere's suggestion: If we remove old version notes from the wiki, we can note this in the version summary to make the notes findable in the version history list.     * Ere asked whether we need version-specific pages in some cases? Can we use a struct plugin to control this in a more structured way? André asked if we should consider snapshotting versions of the wiki at points in time to refer to specific versions? (If so, how do we document upcoming features?). Alternative proposal from Demian: simply state that documentation should be accurate for some number of recent VuFind releases (e.g. latest 2-3 major releases). Older notes could be removed. Since VuFind is designed to be fairly evergreen, this might be a more maintainable solution, and encourage people to upgrade from very old versions while still leaving likelihood of most documentation still applying to older versions. Mohan highlighted the need to upgrade documentation relating to VuFind's integration with third-party systems, since these also change frequently and may require documentation updates. Ere's suggestion: If we remove old version notes from the wiki, we can note this in the version summary to make the notes findable in the version history list.
Line 49: Line 47:
  
 ===== 3. Conflict of Interest Policy ===== ===== 3. Conflict of Interest Policy =====
 +
 +Demian is still waiting for a couple more submissions but expects them soon.
  
 ===== 4. Translation Platform ===== ===== 4. Translation Platform =====
 +
 +André is still working on this. He will make a determination by Friday, 2/17, whether we should use the new translation platform for the 9.0 release translation cycle, or if we should continue to do things "the old way" for one more release before attempting to transition.
  
 ===== 5. Registered Service Provider Update ===== ===== 5. Registered Service Provider Update =====
Line 83: Line 85:
 Next planned "membership drive" -- in tandem with next Summit, which in turn will likely be timed around the next WOLFcon. Next planned "membership drive" -- in tandem with next Summit, which in turn will likely be timed around the next WOLFcon.
  
-See [[community_call:minutes20221206|December 6, 2022]] minutes for brainstorming notes about use of funds.+See [[community:pmc_meetings:minutes20221212#fundraising_communication_plan|December 12, 2022]] minutes for brainstorming notes about use of funds.
  
 ===== 9. Possible Future Actions ===== ===== 9. Possible Future Actions =====
Line 94: Line 96:
   * Marketing project (better VuFind® definition, website improvements, etc.)   * Marketing project (better VuFind® definition, website improvements, etc.)
   * Publication / presentation efforts related to PMC and sustainability   * Publication / presentation efforts related to PMC and sustainability
-  * Look at [[https://wiki.lyrasis.org/display/ITAV/ITAViP+Toolkit%3A+Governance|It Take a Village Toolkit Governance Activities]]. +  * Look at [[https://itav.lyrasis.org/toolkit-governance/|It Take a Village Toolkit Governance Activities]]. 
-  * Look at [[https://wiki.lyrasis.org/display/ITAV/ITAViP+Toolkit%3A+Technology|It Take a Village Toolkit Technology Activities]].+  * Look at [[https://itav.lyrasis.org/toolkit-technology/|It Take a Village Toolkit Technology Activities]].
  
 ===== Other Items ===== ===== Other Items =====
Line 106: Line 108:
  
 Ere also highlighted the value of using different php-fpm pools for different types of requests to avoid getting bogged down by slow third party services. Ere also highlighted the value of using different php-fpm pools for different types of requests to avoid getting bogged down by slow third party services.
 +
 +David plans to share a presentation on Solr statistics in the future.
 +
 +Mohan notes that other RSPs have supported some of the same packages that HealthNet has worked with -- DSpace, Koha, Moodle, etc. -- and will work with Demian to investigate opportunities to collaborate on documentation.
 ===== Action Items ===== ===== Action Items =====
  
 +  * ALL: submit signed Conflict of Interest policy acknowledgments to Demian for submission to the OLF (if you haven't already).
 +  * ALL: consider whether to renew for a second PMC term when our two year anniversary arrives in April, 2023.
 +  * Demian/Mohan: make further progress on updating Koha installation and Open Data Sources wiki pages.
 +  * André/Demian: continue investigation of lokalise platform for i18n (decide whether or not to use lokalise translations for release 9.0 by Friday, February 17).
 +  * André: investigate potential costs of a security audit.
 +  * Demian: Schedule a meeting to discuss training/documentation with Mohan and interested RSP representatives.
 +  * Chris/Demian/Ere: Develop a video to highlight 9.0 changes when the release is finalized.
 +  * Demian: Work with Susan to begin an inventory of wiki content (outdated pages, references to old versions, etc.)
 +  * Any interested parties: Begin research to improve or replace PHP_CodeSniffer, to improve quality of DocBlocks.
 +  * Demian/Leila (if willing): Capture high-level documentation survey results in wiki for future reference.
 +  * ALL: Think about documentation improvements for further discussion next time.
 +  * ALL: Think about whether/how to participate in WOLFcon 2023.
 +  * Demian: include "recruiting a new member" on the agenda for next month, since Leander does not plan to renew for a second term.
 +  * Demian: include documentation on a future Community Call agenda for further discussion.
  
 ---- struct data ---- ---- struct data ----
community/pmc_meetings/minutes20230213.1676303599.txt.gz · Last modified: 2023/02/13 15:53 by demiankatz