Note: This is applicable only to existing integrations. Refer to the Update docs for a new SaaS version tutorial for instructions on adding brand new documentation.

This tutorial covers the steps required to deprecate an integration’s documentation as part of a new major version release.

These steps should be completed after adding a new SaaS version.

Step 1: Create a new permalink

Each integration documentation base has a permalink in the Front Matter that creates the link on the docs website. When adding a new version, you must adjust that link.

The permalink in the latest version you created should look like this: permalink: /integrations/[integration-type]/[integration-name].

In the version you intend to deprecate, the link should look like this: permalink: /integrations/[integration-type]/[integration-type]/v[version-number].

Step 2: Update version file

1. Open the integration’s version file, located in _data/taps/versions/[integration-name].yml

2. In the latest-version field, enter the number of the latest version of the integration:

   latest-version: "2"
   

3. In the released-versions section, locate the version you’re deprecating and do the following:
   1. Update the status to deprecated.

   2. In the deprecation-date field, enter the date the version will be deprecated as Month DD, YYYY.

      The version should now look like the following:

      - number: "1"
        status: "deprecated"
        date-released: "June 28, 2019"
        date-last-connection: "March 5, 2020"
        deprecation-date: "January 1, 2020"
        sunset-date: ""
      

4. Save the file.

Step 3: Refer to your release checklist

If you’re working on a release, refer to the release checklist you’re using to wrap up the remaining steps for launch:

• New SaaS version release checklist
• All release checklists

Last updated: 28 July 2021