Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP - documentation deprecation and archiving policy #9249

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)

Loading