274295 - Clean up web-developer documents

Status: RESOLVED WONTFIX

(www.mozilla.org :: General, defect)

Description

[Anne (:annevk)]

This bug has a couple of goals:
 * Make web-developer documents match the Markup Reference.
 * Make sure their authors are aware of the changes.
 * Drop any local style sheets from the documents.

As a bonus I think we could set up MultiViews as well.

Comment 1

[Daniel Wang]

please don't touch upgrade2 doc until bug 74952 is done.
also, don't touch DOM Ref as others might have plans for it.

in fact, most web dev docs are handled by people other than the original
authors, so you should announce this in the documentation and general newsgroup
first.

Comment 2

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

If the changes you made to the quirks mode documentation are any sign, I think
the markup reference you're citing (URL?) needs major revision.

Comment 3

[Anne (:annevk)]

<http://www.mozilla.org/contribute/writing/markup>

It was written by fantasai, who is one of the website drivers.

The Dom Reference document is bug 273123.

Comment 4

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

That doesn't seem to stipulate that you should reindent other people's documents
the way you think HTML should be indented.

Comment 5

[Daniel Wang]

ouch, that wasn't nice. Anne, you should avoid changing whitespacing because it
makes CVS diff impossible to read. Filed bug 274325 for this rule.

Comment 6

[Anne (:annevk)]

Attachment: patch ./quirks/

This patch adds sections, a rel="up" and replaces the old markup with markup as
described in the mozilla.org Markup Reference. I left indenting the same,
however, I think we should not use tabs in documents.

Comment 7

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

I think we should use tabs, since it's considerably more efficient when it's
sent over the wire.

Also, I have some CSS changes in my doc tree that I'd like to propose that would
make this not mess up the style.  I need to file a bug on that.  Please don't
land this first.

Comment 8

[Anne (:annevk)]

I'm not going to land anything without r from you in this directory ;-)

However, most pages are using spaces instead of tabs.

Comment 9

[Anne (:annevk)]

After waiting about two months, are there any updates on this? Also, would this
document eventually be placed on devmo?

Comment 10

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

Attachment: css changes I was thinking of

These are the CSS changes I was testing.  I haven't had a chance to test them
adequately, though.

Comment 11

[fantasai]

> make this not mess up the style

David, I fail to understand why these changes are prerequisite for improving the
markup on our documentation. It is an aesthetic decision whether or not headings
should be centered or bordered and how much they should be indented. If there is
some particularly atrocious result of applying the site style sheet, please
point it out and we can fix it. But your proposed changes are a bit over the top
for a dependency of this bug, IMHO.

Comment 12

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

Appearance matters, and I think the current stylesheet for sections and headers
makes pages much less readable.

Comment 13

[Gérard Talbot]

Hello all,

This bug blocks bug 151557. 
Can someone clarify, enumerate what still needs to be done in this bug?
If it's ok with Anne, I'm willing to take this bug and resume whatever needs to be resumed.

Regarding *_content_* of the webpage itself
===========================================

It should be noted that some referenced documents are old, outdated or not-upgrade-worthy IMO:

1- 
Slides from CodeStock '99: http://www.mozilla.org/docs/codestock99/
are not upgrade-worthy. The CodeStock '99 documents should be document-graveyarded or archived somewhere and not mentioned anymore in any mozilla.org Web developer documentation webpage.

2-
Javascript Central link points to:
http://devedge-temp.mozilla.org/central/javascript/index_en.html
which I think should be replaced with
http://developer.mozilla.org/en/docs/JavaScript

3-
Code Generator for Setting CSS1 Properties from JavaScript
http://www.mozilla.org/docs/web-developer/css1technote/css1tojs.html
should not be listed as a worthy web developer reference: such document is not useful, not reliable and not upgrade-worthy anymore. Such document should be document-graveyarded or archived and no longer mentioned in any mozilla.org
Web developer documentation.

Regarding markup code practices in the document
===============================================
The Web developer documentation webpage matches, complies with the m.o. Markup Reference.
The Web developer documentation webpage does not use any local stylesheet.

Am I missing something?

Comment 14

[David Boswell]

A redirect was recently set up that sends traffic to this page to MDC's web developer documentation so I'm closing this bug as wontfix.

https://developer.mozilla.org/en/Web_Development

In general, any developer documentation on mozilla.org should be moved to MDC instead of cleaned up or updated on mozilla.org.