[wtp-dev] Q: Where do I put 1.5 readme items?

[Lawrence Mandel <lmandel@xxxxxxxxxx>]

A: There are a couple obvious places
for people to find your readme items.

1. If you feel the readme is appropriate
for the release notes you can place the readme right in the release notes
[1] (there is not yet a link to the 1.5 release notes from the WTP site),
under known problems. Keep in mind that there is already a description
and link in that section to all New, Open and Reopened bugs. This section
should really only be used for those bad bugs that have a good probability
of being encountered by end users and adopters.

2. The WTP FAQ [2] contains useful information.
This is the best place to add your how-to's, infrequently encountered but
irritating problems and work arounds. (For work arounds for problems that
will be fixed it's a good idea to provide a pointer to the bug and identify
the version that the problem exists in.) You can place your readme item
in the FAQ and then refer to it if someone asks about the issue you've
documented. There are separate user and committer FAQs. Please place your
entry in the FAQ you feel is correct. (When i doubt, use the user FAQ.)

And, just because there are two options
doesn't mean you shouldn't use both for entries included in the release
notes. While we don't want to dilute the available information we do want
to make the information as available as possible.

[1] http://www.eclipse.org/webtools/releases/1.5/release-notes.html
[2] http://www.eclipse.org/webtools/faq/main.html

Thanks,

Lawrence Mandel

Software Developer
IBM Rational Software
Phone: 905 - 413 - 3814   Fax: 905 - 413 - 4920
lmandel@xxxxxxxxxx