Skip to content

Commit

Permalink
Create documentation-deprecation-and-archiving-policy.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stevector authored Oct 9, 2024
1 parent 8f02ed9 commit 913bc85
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions source/content/documentation-deprecation-and-archiving-policy.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 913bc85

Please sign in to comment.