db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jean T. Anderson (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2454) Derby Doc Web pages - update FAQ, patch procedures, and tips on formatting
Date Fri, 16 Mar 2007 02:21:10 GMT

    [ https://issues.apache.org/jira/browse/DERBY-2454?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12481438
] 

Jean T. Anderson commented on DERBY-2454:
-----------------------------------------

These changes look fine to me.

Just one minor note -- there's a typo in docsfaq.xml : "Tabs produce inconsisten output."

I have one suggestion for dita.xml that isn't related to anything you changed. I added this
guideline way back when:

   At the very least run ant html, ant monohtml and ant pdf to create HTML and PDF output
(running ant all is best).

I think it could be tweaked to be more helpful/reasonable (not necessary to build the books
you didn't change):

   At the very least run 'ant <manual_id>' to create HTML and PDF output for the book
you are changing.

If you're interested in making that additional change, I'd appreciate it. Or I can catch that
in my next round of web site edits.

> Derby Doc Web pages - update FAQ, patch procedures, and tips on formatting
> --------------------------------------------------------------------------
>
>                 Key: DERBY-2454
>                 URL: https://issues.apache.org/jira/browse/DERBY-2454
>             Project: Derby
>          Issue Type: Improvement
>          Components: Web Site
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>         Attachments: derby2454.zip, docpages031507_2.diff
>
>
> Update the FAQ:
> - How to create cross-references to other topics, other books, and web sties
> - How to format code examples
> Update DITA page:
> - Improve instructions on Creating a patch
> - Improve instructions on Commiting a patch
> Update Guidelines page:
> - Add a section on "Tips to Improve Output Formats"

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message