db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scotsmat...@apache.org
Subject svn commit: r501929 - in /db/derby/site/trunk: build/site/ build/site/manuals/ src/documentation/content/xdocs/ src/documentation/content/xdocs/manuals/
Date Wed, 31 Jan 2007 18:08:19 GMT
Author: scotsmatrix
Date: Wed Jan 31 10:08:18 2007
New Revision: 501929

URL: http://svn.apache.org/viewvc?view=rev&rev=501929
Log:
DERBY-2227: Added a page containing release checklist items and added a new faq to the faq
page. Patch Derby2227-2.diff was contributed by me (Laura Stewart).

Added:
    db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml   (with props)
Modified:
    db/derby/site/trunk/build/site/linkmap.html
    db/derby/site/trunk/build/site/manuals/dita.html
    db/derby/site/trunk/build/site/manuals/docsfaq.html
    db/derby/site/trunk/build/site/manuals/guidelines.html
    db/derby/site/trunk/build/site/manuals/index.html
    db/derby/site/trunk/build/site/manuals/messages.html
    db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml
    db/derby/site/trunk/src/documentation/content/xdocs/site.xml

Modified: db/derby/site/trunk/build/site/linkmap.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/linkmap.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/linkmap.html (original)
+++ db/derby/site/trunk/build/site/linkmap.html Wed Jan 31 10:08:18 2007
@@ -131,6 +131,9 @@
 <div class="menuitem">
 <a href="manuals/docsfaq.html">Writing FAQs</a>
 </div>
+<div class="menuitem">
+<a href="manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Other
Products</div>
 <div id="menu_1.6" class="menuitemgroup">
@@ -509,6 +512,12 @@
 <ul>
 <li>
 <a href="manuals/docsfaq.html">Writing FAQs</a>&nbsp;&nbsp;&nbsp;_________________________&nbsp;&nbsp;<em>docsfaq</em>
+</li>
+</ul>
+    
+<ul>
+<li>
+<a href="manuals/docscheck.html">Release Checklist</a>&nbsp;&nbsp;&nbsp;_________________________&nbsp;&nbsp;<em>docscheck</em>
 </li>
 </ul>
   

Modified: db/derby/site/trunk/build/site/manuals/dita.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/dita.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Wed Jan 31 10:08:18 2007
@@ -77,6 +77,9 @@
 <div class="menuitem">
 <a href="../manuals/docsfaq.html">Writing FAQs</a>
 </div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div class="searchbox">
 <hr>

Modified: db/derby/site/trunk/build/site/manuals/docsfaq.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/docsfaq.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/manuals/docsfaq.html (original)
+++ db/derby/site/trunk/build/site/manuals/docsfaq.html Wed Jan 31 10:08:18 2007
@@ -77,6 +77,9 @@
 <div class="menupage">
 <div class="menupagetitle">Writing FAQs</div>
 </div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div class="searchbox">
 <hr>
@@ -103,6 +106,10 @@
 <li>
 <a href="#Semi-colon+use+at+the+end+of+statements+and+commands">Semi-colon use at the
end of statements and commands</a>
 </li>
+<li>
+<a href="#SQL+terminology%3A+When+do+I+use+the+terms+statement%2C+clause%2C+parameter%2C+%0Aor+expression%3F">SQL
terminology: When do I use the terms statement, clause, parameter, 
+or expression?</a>
+</li>
 </ul>
 </div> 
 
@@ -133,6 +140,50 @@
 </p>
 </div>
 
+<a name="N1002D"></a><a name="SQL+terminology%3A+When+do+I+use+the+terms+statement%2C+clause%2C+parameter%2C+%0Aor+expression%3F"></a>
+<h2 class="boxed">SQL terminology: When do I use the terms statement, clause, parameter,

+or expression?</h2>
+<div class="section">
+<p>
+
+<strong>Statement</strong> should be used only for actual SQL statements, 
+such as these statements:
+</p>
+<pre class="code">
+   ALTER
+   CREATE
+   DELETE
+   GRANT
+   INSERT
+   SELECT
+   UPDATE
+</pre>
+<p>
+
+<strong>Clause</strong> should be used for parts of SQL statements, 
+such as these clauses:
+</p>
+<pre class="code">
+   FROM
+   GROUP BY
+   HAVING
+   ORDER BY
+   VALUES
+   WHERE
+</pre>
+<p>
+
+<strong>Parameter</strong> should be used to describe SQL values that are 
+being passed into and out of procedures. 
+</p>
+<p>
+
+<strong>Expression</strong> should be used for parts of SQL statements that 
+return a value. For more information, see "SQL expressions" in the 
+<a href="http://db.apache.org/derby/docs/dev/ref/">Derby Reference Manual</a>
+
+</p>
+</div>
 
 <p>
 
@@ -143,7 +194,7 @@
 
 
 <p>
-<em>Last Updated: November 7, 2006</em>
+<em>Last Updated: January 29, 2007</em>
 </p>
 
 </div>

Modified: db/derby/site/trunk/build/site/manuals/guidelines.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/guidelines.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/manuals/guidelines.html (original)
+++ db/derby/site/trunk/build/site/manuals/guidelines.html Wed Jan 31 10:08:18 2007
@@ -77,6 +77,9 @@
 <div class="menuitem">
 <a href="../manuals/docsfaq.html">Writing FAQs</a>
 </div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div class="searchbox">
 <hr>

Modified: db/derby/site/trunk/build/site/manuals/index.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/index.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/manuals/index.html (original)
+++ db/derby/site/trunk/build/site/manuals/index.html Wed Jan 31 10:08:18 2007
@@ -77,6 +77,9 @@
 <div class="menuitem">
 <a href="../manuals/docsfaq.html">Writing FAQs</a>
 </div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div class="searchbox">
 <hr>

Modified: db/derby/site/trunk/build/site/manuals/messages.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/messages.html?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/build/site/manuals/messages.html (original)
+++ db/derby/site/trunk/build/site/manuals/messages.html Wed Jan 31 10:08:18 2007
@@ -77,6 +77,9 @@
 <div class="menuitem">
 <a href="../manuals/docsfaq.html">Writing FAQs</a>
 </div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</div>
 </div>
 <div class="searchbox">
 <hr>

Added: db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml?view=auto&rev=501929
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml (added)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml Wed Jan 31 10:08:18
2007
@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"
>
+<document> 
+  <header> 
+    <title>Apache Derby: Release Checklist for Docs</title> 
+  </header> 
+  <body> 
+<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 href="http://wiki.apache.org/db-derby/DerbySnapshotOrRelease">the actions 
+that need to be done for Derby releases</a>
+for more information.
+</p>
+<section>
+<title>Update the conrefs files</title>
+<p>
+<strong>WHEN: After each new release is made public</strong>
+<br></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>
+</section>
+<section>
+<title>Update examples in the manuals</title>
+<p>
+<strong>WHEN: Before each new point release is made public, such as 10.3, 10.4</strong>
+<br></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>
+</section>
+<section>
+<title>Check the licensing and copyright information</title>
+<p>
+<strong>WHEN: As new files are created and before each new release is made public</strong>
+<br></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 <a href="../derby_mail.html">derby-dev</a>
+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 href="https://issues.apache.org/jira/browse/DERBY-2227">Derby-2227.</a>
 
+</p>
+</section>
+<section>
+<title>Update the ditamap files</title>
+<p>
+<strong>WHEN: Only if the content has changed. This does not apply when
+only the formatting has changed. </strong>
+<br></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>
+<source>copyryear year="2002,2007"</source> 
+</section>
+<p>
+<br></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>
+</body>
+</document>

Propchange: db/derby/site/trunk/src/documentation/content/xdocs/manuals/docscheck.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml Wed Jan 31 10:08:18
2007
@@ -43,13 +43,50 @@
 <a href="http://www.nabble.com/Documentation-Style-Issue---semi-colon-at-the-end-of-SQL-statement-examples-tf2141831.html#a5913071">Documentation
Style Issue - semi-colon at the end of SQL statement examples</a>
 </p>
 </section>
-
+<section>
+<title>SQL terminology: When do I use the terms statement, clause, parameter, 
+or expression?</title>
+<p>
+<strong>Statement</strong> should be used only for actual SQL statements, 
+such as these statements:
+</p>
+<source>
+   ALTER
+   CREATE
+   DELETE
+   GRANT
+   INSERT
+   SELECT
+   UPDATE
+</source>
+<p>
+<strong>Clause</strong> should be used for parts of SQL statements, 
+such as these clauses:
+</p>
+<source>
+   FROM
+   GROUP BY
+   HAVING
+   ORDER BY
+   VALUES
+   WHERE
+</source>
+<p>
+<strong>Parameter</strong> should be used to describe SQL values that are 
+being passed into and out of procedures. 
+</p>
+<p>
+<strong>Expression</strong> should be used for parts of SQL statements that 
+return a value. For more information, see "SQL expressions" in the 
+<a href="http://db.apache.org/derby/docs/dev/ref/">Derby Reference Manual</a>
+</p>
+</section>
 <p>
 <br></br>
 Please post feedback to the 
 <a href="../derby_mail.html">derby-dev</a> mail list.
 </p>
 
-<p><em>Last Updated: November 7, 2006</em></p>
+<p><em>Last Updated: January 29, 2007</em></p>
 </body>
 </document>

Modified: db/derby/site/trunk/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/site.xml?view=diff&rev=501929&r1=501928&r2=501929
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/site.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/site.xml Wed Jan 31 10:08:18 2007
@@ -44,7 +44,7 @@
   <community label="Community" tab="community">
     <index label="Get Involved!" href="derby_comm.html"></index>
     <derby_mail label="Mailing Lists" href="derby_mail.html"></derby_mail>
-    <derby_src  label="Source Code" href="dev/derby_source.html"></derby_src>
+    <derby_src label="Source Code" href="dev/derby_source.html"></derby_src>
     <derby_bugs label="BUGS" href="DerbyBugGuidelines.html"></derby_bugs>
     <derby_tests label="Tests" href="derby_tests.html"></derby_tests>
     <logo label="Logo" href="logo.html"></logo>
@@ -57,6 +57,7 @@
     <guidelines label="Writing Guidelines" href="guidelines.html"></guidelines>
     <messages label="Documenting Messages" href="messages.html"></messages>
     <docsfaq label="Writing FAQs" href="docsfaq.html"></docsfaq>
+    <docscheck label="Release Checklist" href="docscheck.html"></docscheck>
   </manuals>
 
   <integrate label="Other Products" href="integrate/" tab="resources">



Mime
View raw message