blob: 59fd6270212343829a388debfa35b9acd0434ac3 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Guide to Retirement</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<meta name="keywords" content="">
<meta name="generator" content="JBake">
<!-- Le styles -->
<link href="../css/incubator.css" rel="stylesheet">
<link href="../css/bootstrap.css" rel="stylesheet">
<link href="../css/asciidoctor.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link href="../css/prettify.css" rel="stylesheet">
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<!-- Fav and touch icons -->
<!--<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../assets/ico/apple-touch-icon-144-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="../assets/ico/apple-touch-icon-114-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="../assets/ico/apple-touch-icon-72-precomposed.png">
<link rel="apple-touch-icon-precomposed" href="../assets/ico/apple-touch-icon-57-precomposed.png">-->
<link rel="shortcut icon" href="https://www.apache.org/favicon.ico">
</head>
<body onload="prettyPrint()">
<div id="wrap">
<!-- Fixed navbar -->
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/"><i class="icon-home"></i>Apache Incubator</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Policies <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/policy/incubation.html">Incubation Policy</a></li>
<li><a href="/ip-clearance/">Intellectual Property Clearance</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Proposals <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/guides/proposal.html">A Guide To Proposal Creation</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Podling Guides <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/cookbook">Cookbook</a></li>
<li><hr><a href="/guides/roles_and_responsibilities.html">Roles and Responsibilities</a></li>
<li><a href="/guides/committer.html">Committers</a></li>
<li><a href="/guides/ppmc.html">Podling Project Management Committee</a></li>
<li><a href="/guides/community.html">Guide to Successful Community Building</a></li>
<li><hr><a href="/guides/branding.html">Incubator Branding Guide</a></li>
<li><a href="/guides/publicity.html">Podling Publicity/Media Guidelines</a></li>
<li><a href="/guides/press-kit.html">Podling Press Kit</a></li>
<li><hr><a href="/guides/transitioning_asf.html">Initial Code Import</a></li>
<li><a href="/guides/names.html">Podling Name Search Guide</a></li>
<li><a href="/guides/ip_clearance.html">Podling IP Clearance</a></li>
<li><hr><a href="/guides/sites.html">Podling Websites</a></li>
<li><a href="/guides/podling_sourcecontrol.html">Podling Source Control</a></li>
<li><hr><a href="/guides/releasemanagement.html">Release Management</a></li>
<li><a href="/guides/distribution.html">Release Distribution</a></li>
<li><hr><a href="/guides/graduation.html">Guide to Successful Graduation</a></li>
<li><a href="/guides/retirement.html">Guide to Retirement</a></li>
<li><a href="/guides/transferring.html">Transferring Resources out of the Incubator</a></li>
<li><hr><a href="/projects/#current">Current Podlings</a></li>
<li><a href="/clutch/">Clutch Report</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">PMC Guides <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/guides/participation.html">Guide to Participation</a></li>
<li><a href="/guides/lists.html">Incubator Mailing Lists Guide</a></li>
<li><a href="/guides/chair.html">Incubator Chair Guide</a></li>
<li><a href="/guides/mentor.html">Mentors' Guide</a></li>
<li><hr><a href="/guides/website.html">Updating the top-level Incubator website</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.apache.org/foundation/how-it-works.html">How Apache Works</a></li>
<li><a href="https://www.apache.org/dev/">Developer Documentation</a></li>
<li><a href="https://www.apache.org/foundation/">Foundation</a></li>
<li><a href="https://www.apache.org/legal/">Legal</a></li>
<li><hr><a href="https://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/security/">Security</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
<li><a href="https://www.apache.org/events/current-event">Current Events</a></li>
</ul>
</li>
<li><a href="/faq.html">FAQs</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-4 vcenter"><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" border="0" style="margin-top: 2px" width="200"></a></div>
<div class="col-md-4 vcenter"><a href="/"><img src="https://incubator.apache.org/images/incubator_feather_egg_logo_sm.png" alt="The Apache Software Foundation Incubator" border="0" style="margin-top: 2px" width="256"></a></div>
<div class="col-md-4 vcenter"><a href="https://www.apache.org/foundation/contributing.html"><img src="https://www.apache.org/images/SupportApache-small.png" style="margin-left: 92px" height="64" width="64"></a></div>
</div>
</div>
<div class="top-container container">
<div class="page-header">
<h1>Guide :: Guide to Retirement</h1>
</div>
<div class="article-body">
Estimated Reading Time: <span class="eta"></span>
<p><div id="toc" class="toc">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#what_is_retirement">What is Retirement?</a></li>
<li><a href="#deciding_to_retire">Deciding to retire</a></li>
<li><a href="#steps_to_retirement">Steps to retirement</a></li>
</ul>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>The intent of this document is to help Mentors and other
community members understand retirement, both as a
concept and a process.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="what_is_retirement">What is Retirement?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A retired podling is one which has been closed down on the
initiative of the PPMC or the IPMC for various reasons. It is
no longer developed at the Apache Incubator and does not have
any other duties.</p>
</div>
<div class="paragraph">
<p>It&#8217;s important to view this process as being the retirement of
the podling community, not the code. It should not be implied
that the code is not for use - just that it has no community.
So long as the Incubator&#8217;s copyright requirements are
fulfilled by the podling prior to retirement, its source code
will continue to be made available through version control.</p>
</div>
<div class="paragraph">
<p>Retiring a podling is analogous to moving a top-level Apache
project to the <a href="http://attic.apache.org">Attic</a>,
but podlings receive a lower level of ongoing support&#8201;&#8212;&#8201;for
example, podling websites are deleted outright rather than
munged to indicate retired status.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="deciding_to_retire">Deciding to retire</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In the vast majority of cases, a podling decides to retire on
its own and that decision is later formally ratified by the
Incubator PMC; very rarely, the IPMC may act unilaterally.
(This is deliberate mimicry of Board oversight of TLPs&#8201;&#8212;&#8201;the language and role titles change but in general the Board
and the IMPC merely implement the wishes of the community.)</p>
</div>
<div class="paragraph">
<p>Before the IPMC gets involved, a public discussion and
community vote SHOULD be held on the podling&#8217;s dev list. This
ensures that all podling stakeholders are properly informed and
have the opportunity to participate in the decision.</p>
</div>
<div class="paragraph">
<p>The final decision to retire the podling takes the form of a
vote by the IPMC on general@incubator. The vote should be by LAZY consensus.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="steps_to_retirement">Steps to retirement</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Once the IPMC vote to retire the podling has closed, a Mentor or other volunteer needs to perform the following steps.</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Update <mark>content/podlings.xml</mark>:</p>
<div class="ulist">
<ul>
<li>
<p>Update podling status to "retired".</p>
</li>
<li>
<p>Add an "enddate" attribute set to the date that the IPMC vote concluded.</p>
</li>
<li>
<p>Remove the "reporting" element.</p>
</li>
<li>
<p>Add the "resolution" element. (Follow the example of other recently retired podlings.)</p>
</li>
</ul>
</div>
</li>
<li>
<p>Update the podling&#8217;s status page with a prominent message indicating when the podling retired: &lt;p&gt;&lt;span class="retired"&gt;The ${podling} podling retired on XXXX-XX-XX&lt;/span&gt;&lt;/p&gt;.</p>
</li>
<li>
<p>Has the copyright checkbox of the podling&#8217;s incubation
status page been checked off? If not, try to resolve it.
If it cannot be resolved, the podling&#8217;s source code must
be removed from version control.</p>
</li>
<li>
<p>It may be that the podling is moving or returning development elsewhere. If so, then modify the resolution attributes appropriately.</p>
</li>
<li>
<p>Delete the podling&#8217;s dist dir, so that its releases will no
longer be mirrored:
<mark>svn remove <a href="https://dist.apache.org/repos/dist/release/incubator/${podling}" class="bare">https://dist.apache.org/repos/dist/release/incubator/${podling}</a></mark>
Any incubating releases will still be available via
<a href="http://archive.apache.org/dist/incubator">archive.apache.org/dist/incubator</a>.</p>
</li>
<li>
<p>Create a file RETIRED.txt at the top-level of each podling
source repository. This should contain something like the following:</p>
<div class="ulist">
<ul>
<li>
<p>This podling has been retired, please see: <a href="http://incubator.apache.org/projects/index.html##{podling-name}" class="bare">http://incubator.apache.org/projects/index.html##{podling-name}</a></p>
</li>
</ul>
</div>
</li>
<li>
<p>If the podling has a DOAP referenced in the <a href="https://svn.apache.org/repos/asf/comdev/projects.apache.org/data/projects.xml">projects.xml</a> file used for generating <a href="http://projects.apache.org">projects.apache.org</a>, remove the entry.</p>
</li>
<li>
<p>Open a "task" INFRA JIRA ticket entitled "Retire the ${podling} Incubator podling". Open sub-tickets using "Create Sub-Task" as applicable:</p>
<div class="ulist">
<ul>
<li>
<p>Close ${podling} mailing lists</p>
</li>
<li>
<p>Make ${podling} version control read-only</p>
</li>
<li>
<p>Move ${podling} JIRA to "retired" and set read-only</p>
</li>
<li>
<p>Make ${podling} wiki read-only</p>
</li>
<li>
<p>Turn off ${podling} automatic builds</p>
</li>
<li>
<p>Update ${podling} Incubator SVN</p>
<div class="ulist">
<ul>
<li>
<p>Add entries to asf-mailer.conf and send mail to cvs at incubator.apache.org</p>
</li>
<li>
<p>Remove entries from asf-authorization - this makes the directory rw to the Incubator PMC.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</li>
<li>
<p>After Infra modifies the website SVN permissions, disable
the podling website by installing an <code>.htaccess</code> like this</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre>RedirectMatch Permanent ^(/.*)?$ http://incubator.apache.org/projects/{podling}.html</pre>
</div>
</div>
<div class="paragraph">
<p>file at the root of the podling website dir which consists
of only a redirect to the podling status page.
- When all steps towards retirement are done, announce completeness on general@incubator.
- Indicate that the podling is closed down in the next board report.</p>
</div>
<div class="paragraph">
<p>The user accounts of the projects committers do not need
to be removed.</p>
</div>
</div>
</div></p>
</div>
</div>
<div id="push"></div>
</div>
<div id="footer">
<div class="container">
<p class="muted credit">&copy; 2021 The Apache Software Foundation | Licensed under the Apache License, Version 2.0.<br/>
Apache Incubator, Apache, the Apache feather logo, and the Apache Incubator project logo are trademarks or registered trademarks of The Apache Software Foundation.</p>
</div>
</div>
<script src="../js/jquery-1.11.1.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/prettify.js"></script>
<script src="../js/readingTime.js"></script>
<script src="../js/incubator.js"></script>
</body>
</html>