From 6c2c9912c575a8acfcda58a3422e889eccb320f0 Mon Sep 17 00:00:00 2001
From: Mike Jang <mjang@gitlab.com>
Date: Thu, 25 Jun 2020 00:57:30 +0000
Subject: [PATCH] Add deprecation language

---
 doc/development/documentation/styleguide.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index abcd1afacb450..a34c766067c08 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -1336,6 +1336,22 @@ a helpful link back to how the feature was developed.
   > - [Moved](<link-to-issue>) to GitLab Core in 12.0.
   ```
 
+- If a feature is deprecated, include a link to a replacement (when available):
+
+  ```markdown
+  > - [Deprecated](<link-to-issue>) in GitLab 11.3. Replaced by [meaningful text](<link-to-appropriate-documentation>).
+  ```
+
+   It's also acceptable to describe the replacement in surrounding text, if available.
+
+   If the deprecation is not obvious in existing text, you may want to include a warning such as:
+
+   ```markdown
+   CAUTION: **Warning:**
+   This feature was [deprecated](link-to-issue) in GitLab 12.3
+   and replaced by [Feature name](link-to-feature-documentation).
+   ```
+
 NOTE: **Note:**
 Version text must be on its own line and surrounded by blank lines to render correctly.
 
-- 
GitLab