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 revisionLast revisionBoth sides next revision | ||
community:documentation_maintenance [2024/03/20 19:55] – [Outdated Page Review] demiankatz | community:documentation_maintenance [2024/04/16 17:51] – 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. | ||
+ | The most recent website and wiki review process was completed in December, 2023. | ||
===== Annual Website and Wiki Review ===== | ===== Annual Website and Wiki Review ===== | ||
- | 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 ==== | ||
Line 26: | Line 25: | ||
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. | 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 | + | |
+ | |||
+ | ==== 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. " | 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. " |
community/documentation_maintenance.txt · Last modified: 2024/04/16 17:56 by demiankatz