The Tetra Data Platform (TDP), like other software, improves by changing iteratively over time. There are times when improvements necessitate that we must deprecate a feature, component (including API endpoints), or function. Deprecate means that we are planning to stop supporting the feature, component, or function in the future. We provide advanced notice of deprecations to help you assess the impact of these changes and make adjustments in your environment to accommodate them.
This topic provides an overview of the guidelines we follow for our deprecation process and notices. For the actual deprecation notices for TDP, see TDP Deprecation Notices
When we deprecate a feature, component, or function, we will provide a deprecation notice to let you know about planned breaking changes that will occur in the product. Notices will be:
- Given, at minimum, 60 days in advance of the removal.
- Provided for deprecations to stable components, features, and functions.
- Posted on the TetraScience documentation website.
- Referenced in our release notes.
Deprecations sometimes include intermediary steps, such as the hiding of a screen in one version that can still be accessed by a URL, then the complete removal of the screen in the next version of TDP.
Note that there are no deprecation notices for BETA components, functions, or features, as those should not be used in production.
We strongly recommend that when you become aware of a deprecation you do the following.
- Assess the impact of the deprecation on your processes, workflows, and data. For example, if the deprecation affects a pipeline trigger, consider whether adjustments might be needed in your pipeline triggers to accommodate the change.
- Do not start new initiatives using the deprecated components.
- Plan to accommodate the deprecation, if needed.
- Consider notifying your internal users about the deprecation if it impacts their work.
- Contact TetraScience if you have questions about the deprecation.
TDP Artifacts are handled separately as it is released more frequently.
Updated about 2 months ago