| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <link rel="stylesheet" href="../style/bootstrap-1-3-0-min.css" type="text/css" /> |
| <link rel="stylesheet" href="../style/style.css" type="text/css" /> |
| <link rel="alternate" title="general@incubator.apache.org Archives" type="application/atom+xml" href="http://mail-archives.apache.org/mod_mbox/incubator-general/?format=atom" /> |
| <title>Guide to Retirement - Apache Incubator</title> |
| |
| </head> |
| <body> |
| <div class="container"> |
| <div class="row"> |
| <div class="span12"> |
| <a href="http://www.apache.org/"><img src="http://incubator.apache.org/images/asf_logo_wide_small.png" alt="The Apache Software Foundation" border="0" style="margin-top: 2px" width="62%"/></a> |
| </div> |
| <div class="span4"> |
| <a href="http://incubator.apache.org/"><img src="../images/egg-logo2.png" alt="Apache Incubator" border="0"/></a> |
| </div> |
| </div> |
| <div class="row"><div class="span16"><hr noshade="noshade" size="1"/></div></div> |
| |
| <div class="row"> |
| <div class="span4"> |
| <form action="http://www.google.com/search" method="get"> |
| <input value="incubator.apache.org" name="sitesearch" type="hidden"/> |
| <input size="20" name="q" id="query" type="text" value="search..." |
| onclick="if(this.value == 'search...') {this.value = ''}"/> |
| <input name="Search" value="Go" type="submit"/> |
| </form> |
| <div class="menuheader">General</div> |
| <menu compact="compact"> |
| <li><a href="../index.html">Welcome</a></li> |
| <li><a href="../incubation/Process_Description.html">Incubation Overview</a></li> |
| <li><a href="../incubation/Incubation_Policy.html">Incubation Policy</a></li> |
| <li><a href="../guides/index.html">Incubation Guides</a></li> |
| <li><a href="../incubation/Roles_and_Responsibilities.html">Roles and Responsibilities</a></li> |
| <li><a href="../faq.html">General FAQ</a></li> |
| <li><a href="http://wiki.apache.org/incubator">Incubator Wiki</a></li> |
| <li><a href="../whoweare.html">Who We Are</a></li> |
| <li><a href="../sitemap.html">Site Map</a></li> |
| </menu> |
| <div class="menuheader">Status</div> |
| <menu compact="compact"> |
| <li><a href="../projects/index.html">Project List</a></li> |
| <li><a href="../clutch.html">Clutch Report</a></li> |
| <li><a href="../ip-clearance/index.html">IP Clearance</a></li> |
| <li><a href="../history/index.html">Incubator History</a></li> |
| </menu> |
| <div class="menuheader">Entry Guides</div> |
| <menu compact="compact"> |
| <li><a href="../guides/proposal.html">Proposal Guide</a></li> |
| </menu> |
| <div class="menuheader">Podling Guides</div> |
| <menu compact="compact"> |
| <li><a href="../guides/committer.html">Podling Committers</a></li> |
| <li><a href="../guides/ppmc.html">Podling PMC (PPMC)</a></li> |
| <li><a href="../guides/mentor.html">Podling Mentor</a></li> |
| <li><a href="../guides/releasemanagement.html">Podling Releases</a></li> |
| <li><a href="../guides/branding.html">Podling Branding/Publicity</a></li> |
| <li><a href="../guides/sites.html">Podling Websites</a></li> |
| <li><a href="../guides/graduation.html">Graduation</a></li> |
| <li><a href="../guides/retirement.html">Retirement</a></li> |
| </menu> |
| <div class="menuheader">Other Guides</div> |
| <menu compact="compact"> |
| <li><a href="../guides/participation.html">Participation</a></li> |
| <li><a href="../faq.html">General FAQ</a></li> |
| <li><a href="../guides/pmc.html">Incubator PMC (IPMC)</a></li> |
| <li><a href="../guides/chair.html">IPMC Chair</a></li> |
| <li><a href="../guides/lists.html">Mailing Lists</a></li> |
| <li><a href="../guides/website.html">Incubator Website</a></li> |
| </menu> |
| <div class="menuheader">ASF</div> |
| <menu compact="compact"> |
| <li><a href="http://www.apache.org/foundation/how-it-works.html">How Apache Works</a></li> |
| <li><a href="http://www.apache.org/dev/">Developer Documentation</a></li> |
| <li><a href="http://www.apache.org/foundation/">Foundation</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </menu> |
| <!-- start Ads Server --> |
| <iframe src="http://www.apache.org/ads/buttonbar.html" |
| style="border-width:0; float: left" frameborder="0" scrolling="no" |
| width="135" height="265"></iframe> |
| <!-- end Ads Server --> |
| </div> |
| |
| <div class="span12"> |
| <h2 id='preamble'><img src="../images/redarrow.gif" />Guide to Retirement</h2> |
| <div class="section-content"> |
| <h3 id='abstract'>Abstract</h3> |
| <div class="section-content"> |
| <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> |
| <h2 id='introduction'><img src="../images/redarrow.gif" />What is Retirement?</h2> |
| <div class="section-content"> |
| <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> |
| <p> |
| It'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's copyright requirements are |
| fulfilled by the podling prior to retirement, its source code |
| will continue to be made available through version control. |
| </p> |
| <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 -- for |
| example, podling websites are deleted outright rather than |
| munged to indicate retired status. |
| </p> |
| </div> |
| <h2 id='decision'><img src="../images/redarrow.gif" />Deciding to retire</h2> |
| <div class="section-content"> |
| <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 -- |
| the language and role titles change but in general the Board |
| and the IMPC merely implement the wishes of the community.) |
| </p> |
| <p> |
| Before the IPMC gets involved, a public discussion and |
| community vote SHOULD be held on the podling's dev list. This |
| ensures that all podling stakeholders are properly informed and |
| have the opportunity to participate in the decision. |
| </p> |
| <p> |
| The final decision to retire the podling takes the form of a |
| vote by the IPMC on general@incubator. |
| </p> |
| </div> |
| <h2 id='steps-to-retirement'><img src="../images/redarrow.gif" />Steps to retirement</h2> |
| <div class="section-content"> |
| <p> |
| Once the IPMC vote to retire the podling has closed, a Mentor |
| or other volunteer needs to perform the following steps. |
| </p> |
| <ol> |
| <li> |
| Update <code>content/podlings.xml</code>: |
| <ul> |
| <li>Update podling status to "retired".</li> |
| <li>Add an "enddate" attribute set to the date that the IPMC vote concluded.</li> |
| <li>Remove the "reporting" element.</li> |
| <li>Add the "resolution" element. (Follow the example of other recently retired podlings.)</li> |
| </ul> |
| </li> |
| <li> |
| Update the podling's status page with a prominent message |
| indicating when the podling retired: <p><span |
| class="retired">The ${podling} podling retired on |
| XXXX-XX-XX</span></p>. |
| </li> |
| <li> |
| Has the copyright checkbox of the podling's incubation |
| status page been checked off? If not, try to resolve it. |
| If it cannot be resolved, the podling's source code must |
| be removed from version control. |
| </li> |
| <li> |
| Delete the podling's dist dir, so that its releases will no |
| longer be mirrored: |
| <pre>svn remove https://dist.apache.org/repos/dist/release/incubator/${podling}</pre> |
| Any incubating releases will still be available via |
| <a href="http://archive.apache.org/dist/incubator">archive.apache.org/dist/incubator</a>. |
| </li> |
| <li> |
| Create a file RETIRED.txt at the top-level of each podling |
| source repository. This should contain something like the |
| following:<br /> |
| <pre>This podling has been retired, please see:<br />http://incubator.apache.org/projects/index.html#{podling-name}</pre> |
| </li> |
| <li> |
| 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. |
| </li> |
| <li> |
| Open a "task" INFRA JIRA ticket entitled "Retire the |
| ${podling} Incubator podling". Open sub-tickets |
| using "Create Sub-Task" as applicable: |
| <ul> |
| <li>Close ${podling} mailing lists</li> |
| <li>(If copyright task completed) Make ${podling} version control read-only</li> |
| <li>(If copyright task <strong>not</strong> completed) Remove ${podling} version control</li> |
| <li>(If JIRA) Move ${podling} JIRA to "retired" and set read-only</li> |
| <li>(If Bugzilla) Close ${podling} Bugzilla</li> |
| <li>Make ${podling} wiki read-only</li> |
| <li>Turn off ${podling} automatic builds</li> |
| <li>Update ${podling} Incubator SVN |
| <ul> |
| <li>Add entries to asf-mailer.conf and send mail to cvs at incubator.apache.org</li> |
| <li>Remove entries from asf-authorizaton - this makes the directory rw to the Incubator PMC.</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li> |
| After Infra modifies the website SVN permissions, disable |
| the podling website by installing an |
| <a href="http://svn.apache.org/repos/asf/incubator/ripple/site/.htaccess">.htaccess</a> |
| file at the root of the podling website dir which consists |
| of only a redirect to the podling status page. |
| </li> |
| <li>When all steps towards retirement are done, announce completeness on general@incubator.</li> |
| <li>Indicate that the podling is closed down in the next board report.</li> |
| </ol> |
| <p> |
| The user accounts of the projects committers do not need |
| to be removed. |
| </p> |
| </div> |
| </div> |
| </div> |
| |
| <div class="row"><div class="span16"><hr noshade="noshade" size="1"/></div></div> |
| <div class="row"> |
| <div class="span16 footer"> |
| Copyright © 2009-2016 The Apache Software Foundation<br /> |
| Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/> |
| Apache Incubator, Apache, the Apache feather logo, and the Apache Incubator project logo are trademarks of The Apache Software Foundation. |
| |
| |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
