Date: Thu, 28 Mar 2024 16:33:35 +0000 (UTC) Message-ID: <14493680.3327.1711643615120@aws-us-west-2-tungsten-confluence-1.web.codeaurora.org> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_3326_669648798.1711643615120" ------=_Part_3326_669648798.1711643615120 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Purpose:
Currently, it appears the best resource to understand feature deprecatio= n comes from Juniper=E2=80=99s release notes.
However, release notes are only accessible once the release is published= , so there is opportunity for confusion for new or existing community membe= rs.
Example:
Release 5.1 has a blueprint illustrating a plan to support Mesos integra= tion. However, 5.1 also announced =E2=80=9Cdeprecation=E2=80=9D for Mesos s= upport.
https://github.com/Juniper/contrail-specs/blob/master/5.1/contrail-mes= osphere-integration.md
Similarly, it may not be clear why or when Tungsten Fabric APIs get depr= ecated. The VNC API documents specific objects or portions of the schema th= at are deprecated. For other APIs such as the vrouter agent, it may be uncl= ear why or when the API changes. It looks like Jira tickets and Blueprints = capture some of these deprecations, but this may not be a comprehensive exe= rcise.
http://www.open= contrail.org/documentation/api/r3.2/contrail_openapi.html
https://github.com/= Juniper/contrail-controller/wiki/Blueprint-Format
The purpose of this wiki page is to outline a community approved depreca= tion policy that will evolve with our community to ensure transparency and = communication with current and prospective community members.
Goals:
Start documenting a deprecation policy. As a community, we should expect= it to evolve and improve over time. That said if we start now and avoid di= srupting current development, it might help avoid barriers to using Tungste= n Fabric. Also, this could help get more TSC involvement with developers to= ensure changes to APIs and features are documented and communicated. Lastl= y, if we want new developers from other organizations, we will need documen= tation like this to level set across the community.
Short Term Ideas:
Longer Term Ideas:
Proposed Verbiage for GitHub/Gerrit:
Tungsten Fabric Feature Deprecation Policy
This document outlines the policies that guide feature and API deprecati= on within the Tungsten Fabric community. The goal of Tungsten Fabric is to = provide the =E2=80=9Cnetwork fabric=E2=80=9D for any cloud and any orchestr= ator. That said, like any open source community, we must prioritize communi= ty needs which may require deprecating features or APIs. It is important fo= r all community members to understand the policies that guide how Tungsten = Fabric communicated these changes with others within the community.
Feature and API Deprecation:
The technical steering committee is responsible for communicating all de= precated features and APIs in release notes and using public announcements.= See the following for example [release notes](TBD) and announcements.
Our goal is to ensure all members understand how Tungsten Fabric changes= when it is released. That said, at this time, we do not have a policy that= outlines how long deprecated features or APIs shall be supported. We are w= orking on updating the release cycle, so as that progresses, we shall updat= e the policies mentioned in this document.
Issues and Exceptions:
We recognize that we may miss some considerations of community members i= n this policy. If so, there are a number of ways to engage us to give feedb= ack or if exceptions are required. We want all community members to be succ= essful, so here are some ways to engage us to check in on a change includin= g mailing lists and Jira tickets.