151952 - [META] Track new tools submissions for documentation

Status: RESOLVED WONTFIX

(mozilla.org :: Miscellaneous, task)

Description

[Alex Vincent [:WeirdAl]]

In the #documentation IRC group, we've been having a discussion about the need
for various tools to support documentation.  This bug is being filed as a
tracking bug specifically for any suggestions on tools we may need to properly
support a powerful documentation system.

A few ideas which have been tossed around:

Docbook, as an official platform for writing documentation
DOxygen, inline in the code to generate docs.
Adding comment notes at the end of a documentation page (like the PHP.net manual)
Including data in catalog for a document's review status & bug filed in Bugzilla
if there is one
A new subdomain, docs.mozilla.org, specifically for handling documentation
A tool for automatically indexing and cross-referencing

If you have an idea for a tool, including one of the possible tools mentioned
above, and you'd like to see it become part of the mozilla.org setup, please
file a new bug for it and mark this bug as blocking it.

Comment 1

[Ben Tremblay]

I see two blocking bugs, one for LXR annotation (152220), and one for tools 
(151961). Would it make sense to open another for DocBook / DocBookSimple / 
Doxygen?

Comment 2

[Alex Vincent [:WeirdAl]]

If you feel DocBook is a tool mozilla.org should have for documentation efforts,
go ahead.  We do have DOxygen linked into Mozilla codebase somewhere (I forget
the exact URI).

Make sure you file your DocBook bug with severity enhancement.  No sense having
it get in the way of actual bugs.

We have been discussing DocBook lately in #documentation and n.p.m.doc, but no
bug has yet been filed regarding it to my knowledge.

One last note:  part of the problem with filing bugs like this is that we don't
necessarily have the people to build these tools available right now.  If you're
willing to investigate implementing it, that's an even better reason to file.

Comment 3

[Dave Miller [:justdave]]

Reassigning to default owner/qa on endico's open bugs so I don't have to watch
her to get mail on them.

Comment 4

[Dave Miller [:justdave]]

This isn't really a server ops bug.  There's nothing for us to do until someone
has an app written and you need somewhere to install it.  Until such time this
is just tracking a generic project.

Comment 5

[Reed Loden [:reed]]

Updating QAContact of all Miscellaneous bugs to [e-mail]. If this particular bug should have a different QAContact, please change it and accept my apologies.

Comment 6

[Mitchell Baker]

Ancient bug; overtaken by time, deveoper.mozilla.org, wikis, etc.
closing.