Skip to content

Deprecating a guide

Jump to bottom
natalie-bernhard edited this page Jul 20, 2023 · 1 revision

Follow these steps to deprecate a guide once its deprecation is approved

  1. Update the guide_tags.json file in this repository and push these changes to the prod branch

    1. In the deprecated tag section, add the guide ID to the list of guides.

    2. Add a new entry to the alt_links object 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:

      Screenshot 2023-07-20 at 7 55 50 AM

  2. If you have a timeframe for when the guide will be fully removed from the site, set a reminder using Slack or Outlook.

  3. When the deprecated guide is ready to be removed from the site:

    1. Remove the guide ID and corresponding alt_links key/value pair from the deprecated tag
    2. Add a new line to guide-redirects.properties in the following format: <deprecated guide ID>=<newer guide ID>
    3. Add “archived-” to the beginning of the guide repository’s name and archive the repo
Clone this wiki locally