[platform-doc-dev] Doc bugs and bugzilla

[John Arthorne <John_Arthorne@xxxxxxxxxx>]

As we start to focus on documentation
for the 3.1 release, I thought I should clarify where doc bugs should be
entered in bugzilla.  There are lots of different kinds of doc, each
with its own set of committers, so it's important that bugs get to the
attention of someone who is able to fix and commit them.  Frequently
doc bugs are mis-filed and end up being stranded in bugzilla with no owner.
 Here is a general breakdown by bugzilla category (feel free to make
corrections, and mention things I have forgotten):

Platform Help: This component is for
the infrastructure that is used to display help and documentation, as opposed
to the actual help content. Log bugs here for problems and feature requests
relating to the implementation of the help window and dynamic help view,
F1 help, etc, but not for the text and images that make up the content.

Platform Doc: Strictly speaking, this
category is only for the org.eclipse.platform.doc.* plugins.  I.e.,
for the actual text and images that make up the documentation books for
the platform (Platform Plugin Developer Guide, and Workbench User Guide).
This includes the migration guide, tips & tricks, and what's new sections.
If you have a doc problem or suggestion that you can't find an appropriate
home for, this component also tends to be the "default" resting
place.

JDT Doc: Content from the org.eclipse.jdt.doc.*
plugins (Java Development User Guide and JDT Plug-in Developer Guide)

PDE Doc: Content from the org.eclipse.pde.doc.user
plugin (PDE Guide)

Platform Releng: The readme_eclipse.html
file included in Eclipse downloads.

Platform Runtime/UI/Debug/CVS/etc -
javadoc, example plugins, and extension point doc are owned by the respective
committers for their corresponding plugins.  Bugs against this content
should be logged with the corresponding component in bugzilla (e.g., a
typo in org.eclipse.ui.* javadoc or an org.eclipse.ui.* extension point
doc would be logged against Platform UI). Also, bugs relating to the binding
of F1 help content to UI elements should be logged with the corresponding
component (for example, if the CVS view didn't have any F1 help, you would
enter a bug against Platform CVS).

Platform Intro: content that appears
in the Welcome view and the tutorials (cheat sheets)

Community Articles: The articles on
eclipse.org

Community Website: Other eclipse.org
content

JDT UI: Problems with the rendering
and generation of javadoc within the Eclipse IDE (such as the Project >
Generate Javadoc command).  I only mention this because I have seen
several bugs about *creation* of javadoc logged as bugs in the platform
doc component.

Have I missed anything?