|
1 | 1 | Deprecation Policy |
2 | 2 | =============================== |
3 | 3 |
|
4 | | -This document outlines the process for announcing deprecated features to the community. The guiding principle is `no surprises <https://docs.mattermost.com/developer/manifesto.html#no-surprises>`__ with guaranteed long-term stability, where admins or users should never run into anything unexpected while using Mattermost. |
5 | | - |
6 | | -Definition of a Deprecated Feature |
7 | | -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
8 | | - |
9 | | -A deprecated feature is considered to be one that breaks backwards compatibility with previous versions. |
10 | | - |
11 | | -Examples include: |
12 | | - |
13 | | -1) Removing an API endpoint, or one of its parameters. |
14 | | - |
15 | | - - APIv3 endpoints on January 16, 2018. |
16 | | - - “permanent” parameter of the DELETE /teams/{team_id} APIv4 endpoint in Mattermost v5.0.0. |
17 | | - |
18 | | -2) Removing a config.json setting |
19 | | - |
20 | | - - System Console settings in Files > Images in Mattermost v4.0.0. |
21 | | - |
22 | | -3) Removing an end user setting or functionality. |
23 | | - |
24 | | - - Font setting in Account Settings > Display in Mattermost v4.0.0. |
25 | | - |
26 | | -Notice |
27 | | -~~~~~~~ |
28 | | - |
29 | | -When the decision to deprecate a feature or function is made, the product manager responsible for the feature carries out the following actions: |
30 | | - |
31 | | -1. Adds the scheduled deprecation to the `deprecated features page <https://about.mattermost.com/deprecated-features/>`__ with a note of what it's been replaced with. |
32 | | -2. Prepares a forum post describing the reasons for deprecating the feature, providing an opportunity for the community to share feedback. See a `sample forum post <https://forum.mattermost.org/t/switching-teammate-name-display-to-a-system-console-setting/3366>`__. |
33 | | -3. Creates a JIRA ticket for removing the feature, including a prefix “Deprecation:” and a fix version matching the removal target date. |
34 | | - |
35 | | -Moreover, the acting release manager takes the following actions: |
36 | | - |
37 | | -1. `12 working days before each release <https://docs.mattermost.com/process/release-process.html#c-t-minus-12-working-days-cut-off-for-merging-major-features>`__, adds a list of deprecated features to the compatibility section of the `changelog <https://docs.mattermost.com/administration/changelog.html>`__ and `important upgrade notes <https://docs.mattermost.com/administration/important-upgrade-notes.html>`__. The changelog should include deprecations scheduled for upcoming releases. |
38 | | -2. `12 working days before each release <https://docs.mattermost.com/process/release-process.html#c-t-minus-12-working-days-cut-off-for-merging-major-features>`__, sends the list of deprecated features to the marketing manager, who includes this information in the release announcement. |
39 | | -3. `2 working days before each release <https://docs.mattermost.com/process/release-process.html#h-t-minus-2-working-days-release-build-cut>`__, ensures the `deprecated features page <https://about.mattermost.com/deprecated-features/>`__ is up to date. |
40 | | - |
41 | | -Removal target date |
42 | | -~~~~~~~~~~~~~~~~~~~~~ |
43 | | - |
44 | | -The removal target date should always be the date of the next major release, such as v4.0.0. If the date is not known, you can reference the next major version rather than the actual release date. |
45 | | - |
46 | | -However, there should always be at least two months from the time the deprecation is announced to its removal. This number is chosen to match our security backport release policy. |
47 | | - |
48 | | -See the table below for examples: |
49 | | - |
50 | | -+-----------------------+---------------------+---------------------+ |
51 | | -| Deprecation Announced | Final Minor Release | Removal Target Date | |
52 | | -+=======================+=====================+=====================+ |
53 | | -| 3.9.0 | 3.10.0 | 4.0.0 | |
54 | | -+-----------------------+---------------------+---------------------+ |
55 | | -| 3.10.0 | 3.10.0 | 5.0.0 | |
56 | | -+-----------------------+---------------------+---------------------+ |
57 | | - |
58 | | -Exceptions for the removal target date may be made if it impacts security or the performance of Mattermost. In such cases, the target date for removing the feature may be made sooner. |
59 | | - |
60 | | -On the other hand, if removing a feature is deemed significant, such as the removal of APIv3 endpoints, the target date for removing the feature may be extended to a later release. |
| 4 | +This page has moved to the `Mattermost Handbook <https://handbook.mattermost.com/operations/research-and-development/product/development-process/deprecated-features>`__. |
0 commit comments