About Features Downloads Getting Started Documentation Events Support GitHub

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

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
community:documentation_maintenance

This is an old revision of the document!


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.

Annual Wiki Review

Each year, members of the Project Management Committee review wiki content for currency and accuracy based on the following criteria:

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.

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.

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. “Removing notes specific to version 3.0”) should be used in the Edit summary to facilitate ongoing access via the “Old revisions” list.

community/documentation_maintenance.1710963125.txt.gz · Last modified: 2024/03/20 19:32 by demiankatz