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.
Next revision | Previous revision | ||
community:documentation_maintenance [2024/03/20 19:32] – created demiankatz | community:documentation_maintenance [2024/04/16 17:56] (current) – [Popular Page Review] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Documentation Maintenance ====== | ====== Documentation Maintenance ====== | ||
- | |||
- | :!: This document is currently a draft and is subject to change. | ||
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. |
+ | See the [[community: | ||
==== Outdated Page Review ==== | ==== Outdated Page Review ==== | ||
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. | ||
- | ==== Release-Specific Note Cleanup ==== | + | === 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. | ||
+ | |||
+ | |||
+ | ==== Points to Consider During Page Review ==== | ||
+ | |||
+ | * If the page references integration with an external product, is the latest version accurately reflected? | ||
+ | * Does the page contain release-specific notes that need to be cleaned up? (See below for guidelines). | ||
+ | |||
+ | === Release-Specific Note Cleanup | ||
+ | |||
+ | Some documentation includes specific notes for different releases of VuFind®. Any version-specific notes referencing releases more than five years old are removed. When saving the removal of these notes, an appropriate description (e.g. " | ||
+ | |||
+ | It is appropriate to retain information about earlier versions in some circumstances; | ||
+ | |||
+ | ===== Learning VuFind® Review ===== | ||
+ | |||
+ | The [[https:// | ||
+ | |||
+ | ===== Video Review ===== | ||
- | Some documentation includes specific notes for different releases of VuFind®. Any version-specific notes referencing releases more than five years old are removed. When saving the removal of these notes, an appropriate description (e.g. " | + | There is not yet a process |
---- struct data ---- | ---- struct data ---- | ||
properties.Page Owner : | properties.Page Owner : | ||
---- | ---- | ||
community/documentation_maintenance.1710963125.txt.gz · Last modified: 2024/03/20 19:32 by demiankatz