You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Laura Stewart (JIRA)" <de...@db.apache.org> on 2006/10/20 17:56:37 UTC

[jira] Created: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Web site - Documentation - Add a new page with writing guidelines
-----------------------------------------------------------------

                 Key: DERBY-1980
                 URL: http://issues.apache.org/jira/browse/DERBY-1980
             Project: Derby
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 10.2.1.8
            Reporter: Laura Stewart
         Assigned To: Laura Stewart
             Fix For: 10.2.2.0


Update the Derby Documentation web pages by:
1) Adding a new page with guidelines for writing documentation. This includes:
- A description of the topic types
- Templates for the topic types
- Guidelines for tagging (indexes, syntax diagrams)
- Guidelines for titles
- How to create links and work with Reltables
2) Update the existing instructions forL
- downloading the source
- locating files
- editing existing topic files


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446748 ] 
            
Rick Hillegas commented on DERBY-1980:
--------------------------------------

Andrew and Jean are right. The file which should not be editted is messages_en.properties. The confusion was sown by me: my original message on this topic contained  the offending blooper.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_1.diff
                derby1980_1.stat
                derby1980_html1.zip

I created a new web page called guidelines.xml (Writing Guidelines) and added some content to this page to help people when they get ready to document Derby features and bugs.

I added some information to the DITA Source page about locating the correct topic.

I updated the site.xml file so that the new "Writing Guidelines" page appears.

This is my first attempt at using Forrest.  Please let me know if you have any questions about the updates.

I have more that I want to make but wanted to get this first round out to determine if there are any problems with the way that I have created/updated the web page files.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Andrew McIntyre (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446741 ] 
            
Andrew McIntyre commented on DERBY-1980:
----------------------------------------

The sentence further down the page should read:

"Do not edit the java/engine/apache/derby/loc/messages_en.properties file."

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12447944 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

Patch derby1980_7.diff committed, revision 472306. Changes should be visible on the web site in an hour. Thanks for the patch, Laura!

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Jean T. Anderson updated DERBY-1980:
------------------------------------

    Derby Info:   (was: [Patch Available])

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12447886 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

Laura, would you mind if I changed the title of the new FAQ page, "Apache Derby: FAQs" to "Apache Derby: Writing FAQs" so that it's obviously specific to the documentation?

There is a general faq for derby at http://db.apache.org/derby/faq.html

You wouldn't need to upload a new patch -- just let me know the page title to plug in.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Derby Info: [Patch Available]

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_html1.zip, derby1980_html3.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446754 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

Thanks for being a pest, Army. :-) Fixed in 470574.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

          Component/s: Web Site
                           (was: Documentation)
        Fix Version/s:     (was: 10.2.2.0)
    Affects Version/s:     (was: 10.2.1.8)

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12447884 ] 
            
Laura Stewart commented on DERBY-1980:
--------------------------------------

This will be the last update for this issue. 
After this last patch (#6) is committed I will close this issue.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Resolved: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart resolved DERBY-1980.
----------------------------------

    Resolution: Fixed
    Derby Info:   (was: [Patch Available])

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446725 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

Committed derby1980_5.diff revision 470517. Changes should be visible on the web site within an hour. Thanks for the patch, Laura.

I think there's some confusion in the new messages page, but it will be easier for people to review when the changes are on the web site.

This statement:

"When you add internationalized messages to the Derby engine, add the messages to the xml descriptors file that is located in ..java/engine/org/apache/derby/loc/messages.xml."

Seems to contradict this sentence further down the page:

"Do not edit the java/engine/apache/derby/loc/messages.xml file. This file has been removed from code management and is now generated from messages.xml during the Derby build."

Which file are messages supposed to be added to?



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12445671 ] 
            
Laura Stewart commented on DERBY-1980:
--------------------------------------

The latest patch files are:

derby1980_2.diff
derby1980_2.stat
derby1980_html1.zip


> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_4.diff
                derby1980_4.stat
                derby1980_html4.zip

Identified a few minor issues.  The latest updates are in the #4 files.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Anonymous (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]


    Attachment: derby1980_2.diff
                derby1980_2.stat

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_6.diff
                derby1980_6.stat
                derby1980_html6.zip

I created a new page "FAQs" to track issues that come up on the list but that I don't want to bury in the 
"Writing Guidelines" page.  

I made minor formatting edits to the "Messages" page

I made minor formatting edits to the "Index" page

I split up the tagging table in the "Writing Guidelines" page to make the different types of tags easier to find (per comment from Kim).

Added "Working with Derby" to the DITA page



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Closed: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart closed DERBY-1980.
--------------------------------


The final patch #7 was committed and checked on the Web site.
Additional Web site issues regarding documentation will need to be logged in a new JIRA issue.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12447964 ] 
            
Laura Stewart commented on DERBY-1980:
--------------------------------------


   [[ Old comment, sent from unregistered email on Tue, 7 Nov 2006 10:49:05 -0800 ]]

Sounds fine Jean.



-- 
Laura Stewart



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: guidelines.xml
                site.xml

These files are DRAFT files.
The "guidelines" file should go in this directory: \trunk\src\documentation\content\xdocs\manuals
The "site" file should go in this directory" \trunk\src\documentation\content\xdocs

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12445702 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

This looks good to me and getting it up on the web site will help further review because the web site skin and links will be active. 

Committed patch derby1980_2.diff, revision 469254. It'll take about an hour for the change to become visible on the web site.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_3.diff
                derby1980_3.stat
                derby1980_html3.zip

Added another page for Messages.

Added a lot more content to the Writing Guidelines page.



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_html1.zip, derby1980_html3.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446751 ] 
            
A B commented on DERBY-1980:
----------------------------

Not to be a pest, but I think the word "org" is still missing from the filename:

> ls java/engine/apache/derby/loc/messages_en.properties
ls: File or directory "java/engine/apache/derby/loc/messages_en.properties" is not found
> ls java/engine/org/apache/derby/loc/messages_en.properties
java/engine/org/apache/derby/loc/messages_en.properties



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Jean T. Anderson (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12446746 ] 
            
Jean T. Anderson commented on DERBY-1980:
-----------------------------------------

Thanks for that correction, Andrew. It's fixed in revision 470562 and will be visible after the next web site sync.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Derby Info: [Patch Available]

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.2.1.8
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.2.0
>
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_html1.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_7.diff
                derby1980_7.stat
                derby1980_html7.zip

Discovered that the description for the Working with Derby guide was not accurate.
Updated that.

Patch #7 contains all of the updates documented in patch #6.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1980?page=all ]

Laura Stewart updated DERBY-1980:
---------------------------------

    Attachment: derby1980_5.diff
                derby1980_5.stat

Recreated the diff and stat files from the src directory.

> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DERBY-1980) Web site - Documentation - Add a new page with writing guidelines

Posted by "Laura Stewart (JIRA)" <ji...@apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1980?page=comments#action_12447965 ] 
            
Laura Stewart commented on DERBY-1980:
--------------------------------------


   [[ Old comment, sent from unregistered email on Tue, 7 Nov 2006 11:13:59 -0800 ]]



If you mean what to put in the site.xml file, how about "docsfaq"

-- 
Laura Stewart



> Web site - Documentation - Add a new page with writing guidelines
> -----------------------------------------------------------------
>
>                 Key: DERBY-1980
>                 URL: http://issues.apache.org/jira/browse/DERBY-1980
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby1980_1.diff, derby1980_1.stat, derby1980_2.diff, derby1980_2.stat, derby1980_3.diff, derby1980_3.stat, derby1980_4.diff, derby1980_4.stat, derby1980_5.diff, derby1980_5.stat, derby1980_6.diff, derby1980_6.stat, derby1980_7.diff, derby1980_7.stat, derby1980_html1.zip, derby1980_html3.zip, derby1980_html4.zip, derby1980_html6.zip, derby1980_html7.zip, guidelines.xml, site.xml
>
>
> Update the Derby Documentation web pages by:
> 1) Adding a new page with guidelines for writing documentation. This includes:
> - A description of the topic types
> - Templates for the topic types
> - Guidelines for tagging (indexes, syntax diagrams)
> - Guidelines for titles
> - How to create links and work with Reltables
> 2) Update the existing instructions forL
> - downloading the source
> - locating files
> - editing existing topic files

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira