-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdeprecation.html
201 lines (158 loc) · 9.77 KB
/
deprecation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Mantid Deprecation Policy</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=fadd4351" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=77160d70" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<script src="_static/documentation_options.js?v=694ca900"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Workspace Toolbox" href="workbench/workspacetreewidget.html" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org">
</a>
<span class="navbar-text navbar-version pull-left"><b>6.11</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="https://www.mantidproject.org">Home</a></li>
<li><a href="https://download.mantidproject.org">Download</a></li>
<li><a href="https://docs.mantidproject.org">Documentation</a></li>
<li><a href="https://www.mantidproject.org/contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Mantid Deprecation Policy</a></li>
</ul>
</div> </p>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<p><span class="math notranslate nohighlight">\(\renewcommand\AA{\unicode{x212B}}\)</span></p>
<section id="mantid-deprecation-policy">
<span id="deprecation-policy"></span><h1><a class="toc-backref" href="#id1" role="doc-backlink">Mantid Deprecation Policy</a><a class="headerlink" href="#mantid-deprecation-policy" title="Link to this heading">¶</a></h1>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#mantid-deprecation-policy" id="id1">Mantid Deprecation Policy</a></p>
<ul>
<li><p><a class="reference internal" href="#introduction" id="id2">Introduction</a></p></li>
<li><p><a class="reference internal" href="#what-will-we-deprecate" id="id3">What will we deprecate?</a></p></li>
<li><p><a class="reference internal" href="#timescales" id="id4">Timescales</a></p></li>
<li><p><a class="reference internal" href="#communication" id="id5">Communication</a></p></li>
<li><p><a class="reference internal" href="#process-of-deprecating-an-algorithm" id="id6">Process of deprecating an algorithm</a></p></li>
<li><p><a class="reference internal" href="#soft-deprecation" id="id7">Soft Deprecation</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="introduction">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Introduction</a><a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2>
<p>This policy lays out how we deprecate algorithms, interfaces and other parts of Mantid. It is intended as a reference
for both users and developers.</p>
</section>
<section id="what-will-we-deprecate">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">What will we deprecate?</a><a class="headerlink" href="#what-will-we-deprecate" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Algorithms that have not been used for 3 years or more. We will use Usage Data to determine this. For more information
about how we record Usage data please see our <a class="reference external" href="https://www.mantidproject.org/privacy.html#usage-data-recorded-in-mantid">Privacy Policy: Usage Data Recorded in Mantid</a></p></li>
<li><p>Other Features covered by Usage Data that have not been used for 3 or more years</p></li>
<li><p>Soft deprecation of Algorithms superseded by newer versions of an algorithm e.g. v1 deprecated when v2 has been created.
See below for more about soft deprecation.</p></li>
</ul>
<p>Apart from soft deprecation, the decision to mark an algorithm or feature as deprecated must be agreed with the <a class="reference external" href="https://github.com/mantidproject/governance/tree/main/technical-working-group">Technical
Working Group</a>.</p>
</section>
<section id="timescales">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Timescales</a><a class="headerlink" href="#timescales" title="Link to this heading">¶</a></h2>
<p>When an algorithm or feature has been identified for deprecation it will be marked as deprecated for a minimum of 2
releases before finally being removed.</p>
</section>
<section id="communication">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Communication</a><a class="headerlink" href="#communication" title="Link to this heading">¶</a></h2>
<p>To ensure users are aware of deprecated algorithms and other features
- Mark as deprecated in code base with suitable warning message for users in the log
- Mark as deprecated in supporting documentation
- Add deprecation to release notes</p>
<p>When the code is being removed from the release that is being developed
- Post to the <a class="reference external" href="https://forum.mantidproject.org/">Mantid Forum</a>
- E-mail the Mantid Announcements e-mail list (to join this list see our <a class="reference external" href="https://www.mantidproject.org/contact">Contact Us</a> page.
- Technical Working Group members will communicate the removal to the facilities they represent
- A list of removed algorithms/features will be listed in the <a class="reference internal" href="release/index.html#release-notes"><span class="std std-ref">Release Notes</span></a> for that release</p>
</section>
<section id="process-of-deprecating-an-algorithm">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Process of deprecating an algorithm</a><a class="headerlink" href="#process-of-deprecating-an-algorithm" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Check usage reporting as to whether algorithm/feature has been used within last 3 years.</p></li>
<li><p>If it has not be used within last three years make a request to the Technical Working Group (TWG) to have it deprecated</p></li>
<li><p>If approved by the TWG follow the guidance under the Communication section above.</p></li>
<li><p>If removing more than one algorithm/feature from the code base do each one in a separate pull request. This is to allow
for deprecations to be reversed if necessary.</p></li>
</ul>
</section>
<section id="soft-deprecation">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Soft Deprecation</a><a class="headerlink" href="#soft-deprecation" title="Link to this heading">¶</a></h2>
<p>When algorithms are replaced with newer versions, the previous version(s) will be subject to a soft deprecation. We will
make it clear that we are no longer supporting (i.e. no longer developing) the previous version(s). Although previous
versions will still be available and safe to use, users will be encouraged to use more recent versions.</p>
<p>Once older versions have gone out of use for at least 3 years they will then be subject to the deprecation process as
outlined above.</p>
</section>
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="workbench/workspacetreewidget.html" title="Previous Chapter: Workspace Toolbox"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Workspace Toolbox</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>