db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scotsmat...@apache.org
Subject svn commit: r501996 - /db/derby/site/trunk/build/site/manuals/docscheck.html
Date Wed, 31 Jan 2007 21:07:29 GMT
Author: scotsmatrix
Date: Wed Jan 31 13:07:28 2007
New Revision: 501996

URL: http://svn.apache.org/viewvc?view=rev&rev=501996
Log:
Derby-2227: Added a new page as a release checklist. Patch submitted by me (Laura Stewart).

Added:
    db/derby/site/trunk/build/site/manuals/docscheck.html   (with props)

Added: db/derby/site/trunk/build/site/manuals/docscheck.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/docscheck.html?view=auto&rev=501996
==============================================================================
--- db/derby/site/trunk/build/site/manuals/docscheck.html (added)
+++ db/derby/site/trunk/build/site/manuals/docscheck.html Wed Jan 31 13:07:28 2007
@@ -0,0 +1,322 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.7">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Apache Derby: Release Checklist for Docs</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script
src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script
src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> &gt; <a href="http://db.apache.org/">db</a><script
src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<div class="header">
+<div class="grouplogo">
+<a href="http://db.apache.org/derby"><img class="logoImage" alt="Apache Derby" src="../images/derby-logo-web.png"
title="Derby is a zero-admin Java RDBMS"></a>
+</div>
+<div class="projectlogoA1">
+<a href="http://db.apache.org"><img class="logoImage" alt="Apache DB Project" src="../images/db-logo-white.png"
title="Apache DB creates and maintains database solutions."></a>
+</div>
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="base-not-selected" href="../quick_start.html">Quick Start</a>
+</li>
+<li>
+<a class="base-not-selected" href="../derby_downloads.html">Download</a>
+</li>
+<li>
+<a class="base-not-selected" href="../derby_comm.html">Community</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../manuals/index.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../integrate/index.html">Resources</a>
+</li>
+</ul>
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<div id="level2tabs"></div>
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+//  --></script>
+</div>
+<div class="breadtrail">
+             
+             &nbsp;
+           </div>
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title"
class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../manuals/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/dita.html">DITA Source</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/guidelines.html">Writing Guidelines</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/messages.html">Documenting Messages</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docsfaq.html">Writing FAQs</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Release Checklist</div>
+</div>
+</div>
+<div class="searchbox">
+<hr>
+<form action="http://www.google.com/search" method="get">
+<input value="db.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank
(this, 'Search the site with google');" size="18" name="q" id="query" type="text" value="Search
the site with google">&nbsp; 
+                  <input attr="value" name="Search" value="Search" type="submit">
+</form>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<div id="credit2"></div>
+</div>
+<div id="content">
+<div class="trail">
+<text>Font size:</text> 
+	          &nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset');
return false;" type="button">      
+	          &nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr');
return false;" type="button">
+	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr');
return false;" type="button">
+</div>
+<h1>Apache Derby: Release Checklist for Docs</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Update+the+conrefs+files">Update the conrefs files</a>
+</li>
+<li>
+<a href="#Update+examples+in+the+manuals">Update examples in the manuals</a>
+</li>
+<li>
+<a href="#Check+the+licensing+and+copyright+information">Check the licensing and copyright
information</a>
+</li>
+<li>
+<a href="#Update+the+ditamap+files">Update the ditamap files</a>
+</li>
+</ul>
+</div> 
+
+<p>
+For each release, the following list of items should be used as a checklist
+by the people making documentation contributions. This checklist contains
+items that should be reviewed (and updated) before each new Derby release is 
+approved and goes live.
+</p>
+
+<p>
+You can read a high-level writeup on 
+<a class="external" href="http://wiki.apache.org/db-derby/DerbySnapshotOrRelease">the
actions 
+that need to be done for Derby releases</a>
+for more information.
+</p>
+
+<a name="N10017"></a><a name="Update+the+conrefs+files"></a>
+<h2 class="boxed">Update the conrefs files</h2>
+<div class="section">
+<p>
+
+<strong>WHEN: After each new release is made public</strong>
+
+<br>
+The conref files for the Derby manuals need to be updated so that the 
+Alpha versions of the manuals reflect the next release number.  
+This task needs to be completed for each new minor and point release.
+</p>
+<p>
+To complete this task:
+</p>
+<ol>
+
+<li>Ask on the derby-dev list what the correct release number is (minor
+or point).</li>
+
+<li>Create a JIRA issue for this task. </li>
+
+<li>Open the conrefs files for each Derby manual. For example: devconrefs.dita </li>
+
+<li>In the "Version and release numbers" section, change the ph tag for
+shortversionnumber. </li>
+
+<li> If this is a new major release, for example from 10 to 11,
+in the "Product specific entities" section change the ph tag for
+productinstallname.  </li>
+
+</ol>
+<p>
+If a new manual has been added to the Derby documentation set, you must list the
+new manual in the "pub" section in each conrefs file.
+</p>
+</div>
+
+<a name="N1003E"></a><a name="Update+examples+in+the+manuals"></a>
+<h2 class="boxed">Update examples in the manuals</h2>
+<div class="section">
+<p>
+
+<strong>WHEN: Before each new point release is made public, such as 10.3, 10.4</strong>
+
+<br>
+Some of the examples in the manuals contain specific 
+date references. For the documentation to be current, these references
+need to be updated each release.  
+</p>
+<p>
+In the <strong>Working with Derby</strong> 
+manual, the following files need to be updated:
+</p>
+<ul>
+
+<li>twwdactivity1.dita</li>
+
+<li>twwdactivity2.dita</li>
+
+<li>twwdactivity3_Setup.dita</li>
+
+<li>twwdactivity4.dita</li>
+
+</ul>
+<p>
+In the <strong>Reference Guide</strong> 
+manual, the following files need to be updated:
+</p>
+<ul>
+
+<li>rrefdayfunc.dita</li>
+
+</ul>
+<p>
+In the <strong>Developer's Guide</strong> 
+manual, the following files need to be updated:
+</p>
+<ul>
+
+<li>cdevdvlp27715.dita</li>
+
+</ul>
+<p>
+Additionally, some of the files in the <strong>Working with Derby</strong> guide

+have specific release and tag values that need to be updated each release.  
+The following files need to be updated:
+</p>
+<ul>
+
+<li>twwdactivity1.dita</li>
+
+<li>twwdactivity2.dita</li>
+
+<li>twwdactivity4.dita</li>
+
+</ul>
+</div>
+
+<a name="N1008C"></a><a name="Check+the+licensing+and+copyright+information"></a>
+<h2 class="boxed">Check the licensing and copyright information</h2>
+<div class="section">
+<p>
+
+<strong>WHEN: As new files are created and before each new release is made public</strong>
+
+<br>
+Each new dita file that is created must contain licensing information 
+at the top of the file. This information is internal and does not print out.
+The template files contain this hidden licensing information. 
+</p>
+<p>
+If you used the DITA topic templates to create your new files, the licensing
+information should appear at the top of the topic in your editor. If you did not 
+use the template files, you must paste a copy of this information into each
+new topic that you created in this release. The templates 
+are located in the <strong>\trunk\templates</strong> directory.
+</p>
+<p>
+Additionally, each manual must display copyright information at the beginning
+of the output along with a date. The date should be updated as necessary.
+Sometimes the wording of the copyright changes. Check with Apache for any 
+updates to the copyright wording.
+</p>
+<p>
+If the licensing wording needs to be changed in all of the files, you can use
+the following steps to update the topics and the generated output:
+</p>
+<p>
+For more information on ASF copyright requirements, see the comments on
+JIRA issue <a class="external" href="https://issues.apache.org/jira/browse/DERBY-2227">Derby-2227.</a>
 
+
+</p>
+</div>
+
+<a name="N100AE"></a><a name="Update+the+ditamap+files"></a>
+<h2 class="boxed">Update the ditamap files</h2>
+<div class="section">
+<p>
+
+<strong>WHEN: Only if the content has changed. This does not apply when
+only the formatting has changed. </strong>
+
+<br>
+For each manual, there is a ditamap file which contains a <strong>copyryear</strong>
+tag.  The tag displays 2 years, the first year the content in the manual was 
+developed and the last year that the content in the manual was modified. 
+If any file in a manual is updated during the year, the second year in the 
+<strong>copyryear</strong> tag must be updated.
+</p>
+<p>
+For example, if the tag has "copyryear year="2002,2006" and the contents are
+changed in 2007, you must update the second year so that the tag reads:
+</p>
+<pre class="code">copyryear year="2002,2007"</pre>
+</div>
+
+<p>
+
+<br>
+Please post feedback to the 
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+
+
+<p>
+<em>Last Updated: January 29, 2007</em>
+</p>
+
+</div>
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2004-2006 Apache Software Foundation</div>
+<div id="feedback">
+    Send feedback about the website to:
+  <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0manuals/docscheck.html">derby-user@db.apache.org</a>
+</div>
+</div>
+</body>
+</html>

Propchange: db/derby/site/trunk/build/site/manuals/docscheck.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message