Warning: This page has not been updated in over over a year and may be outdated or deprecated.
community:documentation_maintenance
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
community:documentation_maintenance [2024/03/20 19:35] – [Release-Specific Note Cleanup] demiankatz | community:documentation_maintenance [2024/04/16 15:04] – [Annual Website and Wiki Review] demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
Maintaining useful and accurate documentation helps to ensure the health and sustainability of the project. This page describes how the VuFind® project maintains its documentation. | Maintaining useful and accurate documentation helps to ensure the health and sustainability of the project. This page describes how the VuFind® project maintains its documentation. | ||
- | ===== Annual Wiki Review ===== | + | The most recent website and wiki review process was completed in December, 2023. |
+ | ===== Annual | ||
- | Each year, members of the [[community: | + | Each year, generally coinciding with a major release of the software, members of the [[community: |
==== Popular Page Review ==== | ==== Popular Page Review ==== | ||
- | Based on web analytics gathered using Matomo, data from the prior calendar year is used to identify (at minimum) the 50 most popular pages on the wiki. These pages are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. | + | Based on web analytics gathered using Matomo, data from the prior calendar year is used to identify (at minimum) the 50 most popular pages on vufind.org. These pages are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. |
==== Outdated Page Review ==== | ==== Outdated Page Review ==== | ||
Line 17: | Line 18: | ||
Based on file age data gathered from Dokuwiki, pages which have not been edited in at least three years (excluding historical pages such as meeting minutes) are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. | Based on file age data gathered from Dokuwiki, pages which have not been edited in at least three years (excluding historical pages such as meeting minutes) are distributed to PMC members with appropriate expertise for review, and are checked for accuracy. | ||
+ | === Identifying Outdated Pages === | ||
+ | |||
+ | On the server, running the following command in the data/pages subdirectory of Dokuwiki will return a list of pages that should be reviewed: | ||
+ | |||
+ | <code bash> | ||
+ | find -type f -mtime +1095 -size +150c | grep -v " | ||
+ | </ | ||
+ | |||
+ | This finds files over three years old and greater than 150 bytes (since many old files are small redirects to other pages); it also filters out various filename patterns that indicate historical content. | ||
==== Release-Specific Note Cleanup ==== | ==== Release-Specific Note Cleanup ==== | ||
Line 22: | Line 32: | ||
It is appropriate to retain information about earlier versions in some circumstances; | It is appropriate to retain information about earlier versions in some circumstances; | ||
+ | |||
+ | ===== Learning VuFind® Review ===== | ||
+ | |||
+ | The [[https:// | ||
+ | |||
+ | ===== Video Review ===== | ||
+ | |||
+ | There is not yet a process for reviewing (and potentially re-recording) video tutorials. This is another topic for future consideration. | ||
---- struct data ---- | ---- struct data ---- | ||
properties.Page Owner : | properties.Page Owner : | ||
---- | ---- | ||
community/documentation_maintenance.txt · Last modified: 2024/04/16 17:56 by demiankatz