-
Notifications
You must be signed in to change notification settings - Fork 6
Deprecating a guide
natalie-bernhard edited this page Jul 20, 2023
·
1 revision
-
Update the guide_tags.json file in this repository and push these changes to the prod branch
-
In the
deprecatedtag section, add the guide ID to the list of guides. -
Add a new entry to the
alt_linksobject in this format:<deprecated guide ID>:<newer guide ID>After each entry, place a comma, and then begin a new line. The deprecated guide is the key (left), and the alternative guide is the value (right).Example:
-
-
If you have a timeframe for when the guide will be fully removed from the site, set a reminder using Slack or Outlook.
-
When the deprecated guide is ready to be removed from the site:
- Remove the guide ID and corresponding
alt_linkskey/value pair from thedeprecatedtag - Add a new line to
guide-redirects.propertiesin the following format:<deprecated guide ID>=<newer guide ID> - Add “archived-” to the beginning of the guide repository’s name and archive the repo
- Remove the guide ID and corresponding