From 913bc8521b2823108977a74419e0ba5b816570c4 Mon Sep 17 00:00:00 2001 From: Steve Persch Date: Wed, 9 Oct 2024 11:20:17 -0500 Subject: [PATCH] Create documentation-deprecation-and-archiving-policy.md --- ...tation-deprecation-and-archiving-policy.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 source/content/documentation-deprecation-and-archiving-policy.md diff --git a/source/content/documentation-deprecation-and-archiving-policy.md b/source/content/documentation-deprecation-and-archiving-policy.md new file mode 100644 index 0000000000..0bf653c1c1 --- /dev/null +++ b/source/content/documentation-deprecation-and-archiving-policy.md @@ -0,0 +1,39 @@ +--- +title: Documentation Deprecation and Archiving Policy +description: Guidelines for how Pantheon's documentation team handles documentation related to deprecated features or out of date documentation that will not be further updated. +contributors: [stevector] +reviewed: "2024-10-16" +contenttype: [doc] +showtoc: true +categories: [overview, help] +newcms: [drupal, wordpress] +audience: [agency, business, development, marketing, sysadmin] +product: [--] +integration: [--] +--- + + +Intro paragraph + +### How do we handle documentation that is still accurate but not recommended or relevant? + +Example of Drupal 8 codebase guides. + +### How do we handle documentation that people may search for but is not valid anymore? + +Lockr example? + +### How do we handle documentation for deprecated Pantheon features / plugins? + +Edge integrations example that emphasizes that we've deprecated open source plugins / modules. +The capacities of the Pantheon platform those open source tools leaned on are still present. + +### Is there a difference between "archiving" and "deprecating"? + +Hmmm. Edge Integration repos are "archived," meaning they're not going to change while archived. + +In the parlance of OSS, "deprecated" generally means something is going to be removed in the next version but it is still functional. (and I suppose could still change in some why prior to total removal) + +Another difference here is the relationship to time. "Archived" communicates something about the past mostly. The thing *was* put in the archive (with the implication that it will not change in the present/future). +"Deprecated" communicates something about the future (the thing will be removed / stop working in the future, because of a decision made in the past) +