Proposal - New page for "Release Checklist for Docs" to Derby Doc Web Pages (WAS Re: [jira] Commented: (DERBY-2194) A few more problems with Working with Derby manual

[Laura Stewart <sc...@gmail.com>]

>> Kim - What do you think about documenting this somewhere on
>> the Derby Documentation Web Page
>> http://db.apache.org/derby/manuals/dita.html so that anyone who
>> is working on documentation for Derby can see a list of things to
>> do each major release (10.3, 10.4, etc) ???

>
> Kim Haase commented on DERBY-2194:
> ----------------------------------
>
> It would be useful to put that information somewhere, although the writing guidelines page might be more suitable. The DITA page is focused mainly on tools and setup.
>
> Parts of the Working with Derby updating task may need to be done for minor releases as well, since the release tag changes every time.
>
> What else might go into this list? Updating the conrefs files comes to mind. I'm not sure what else.
>

I don't think this info really fits on any existing page that we have.

I suggest that we add a new page to the Derby Documentation set of Web
pages. This new page would list anything that should be done each
release to the documentation.

For example:
- Update the release in the conrefs files for each manual
- Update the examples in the Working with Derby manual to reflect
current dates/times (with a list of the specific file names to be
updated)


-- 
Laura Stewart

Re: Proposal - New page for "Release Checklist for Docs" to Derby Doc Web Pages (WAS Re: [jira] Commented: (DERBY-2194) A few more problems with Working with Derby manual

[Kim Haase <Ca...@Sun.COM>]

I agree that this is a good idea.

There's a copyright tag in each ditamap file, too, so that can be added 
to Jean's suggestion.

Kim

Jean T. Anderson wrote:
> Laura Stewart wrote:
> ...
>> I suggest that we add a new page to the Derby Documentation set of Web
>> pages. This new page would list anything that should be done each
>> release to the documentation.
>>
>> For example:
>> - Update the release in the conrefs files for each manual
>> - Update the examples in the Working with Derby manual to reflect
>> current dates/times (with a list of the specific file names to be
>> updated)
> 
> Also,
> 
>   - Check to see if the copyright page in each book needs to be updated
> 
>  -jean

Re: Proposal - New page for "Release Checklist for Docs" to Derby Doc Web Pages (WAS Re: [jira] Commented: (DERBY-2194) A few more problems with Working with Derby manual

["Jean T. Anderson" <jt...@bristowhill.com>]

Laura Stewart wrote:
...
> I suggest that we add a new page to the Derby Documentation set of Web
> pages. This new page would list anything that should be done each
> release to the documentation.
> 
> For example:
> - Update the release in the conrefs files for each manual
> - Update the examples in the Working with Derby manual to reflect
> current dates/times (with a list of the specific file names to be
> updated)

Also,

  - Check to see if the copyright page in each book needs to be updated

 -jean