Closed Bug 53055 Opened 26 years ago Closed 25 years ago

need location for web developer documentation on mozilla.org

Categories

(Documentation Graveyard :: Web Developer, defect, P3)

Other
Other
defect

Tracking

(Not tracked)

VERIFIED FIXED

People

(Reporter: dbaron, Unassigned)

Details

Attachments

(1 file)

I think we should have a location for web developer documentation (separate from mozilla developer documentation) on mozilla.org. There is a very small amount of web developer documentation on the mozilla developer documentation page (http://www.mozilla.org/docs/ ), and I have a few more pieces of documentation that I would like to add. I think Mozilla developer documentation and web developer documentation should be kept separate to make finding things easier. It is almost always easy to classify documentation in one catogory or the other, and in any cases where it is not a page could be linked from both locations. I am willing to maintain the index for such a page of web developer documentation. We need to decide: * where such an index page should be and what should link to it * where in the directory structure we should be putting new web developer documentation (what exists can stay where it is) The two options I can think of for page locations are: * put the index in a subdirectory of docs, and put new web developer docs in that directory as well * make a new top-level subdirectory for web developer docs, and make its index page the new index I would prefer the latter solution, plus linking to the web developer documentation page from the top of the existing docs page, but I don't have very strong feelings on the matter. Mostly I just want something rather than nothing...
adding steve rudman to cc:list
Ian, the bug is assigned to me. Removing myself from cc list. Accepting.
Status: NEW → ASSIGNED
Does anybody else care? I might even still be able to find the documentation I wrote...
I don't agree that it is easy to distinguish between web developer and mozilla developer docs. We've been around and around on this issue, and when we started to index the docs, we found that in many cases it's too hard to make the split. "Web developers" and "mozilla developers" would be equally interested in, say, XUL. Ditto for JavaScript. Perhaps you could provide some examples, though, to indicate what you mean. We could have a separate section on the main docs page for web developer docs/info, which could duplicate links to docs that are indexed elsewhere. So cleaning up the main page seems to be a solution, rather than creating new directory structures.
I don't think XUL is relevant to web developers. General JavaScript stuff would be useful to both, that's true, so it could be linked from both pages. However, that's a rare case. There should be a place for web developers to go to look for docs. Unless I think people are actually going to find documentation that I write, I'm not going to write it. And with the current arrangement, I don't think they will. So I'm not going to write any unless the current arrangement changes. I am volunteering to maintain the page of web developer documentation if you're willing to let me create it.
David Just created a new subdir (www.mozilla.org/docs/web-developer) on mozilla.org. There is no index page yet. Do you have CVS check-in access? If so, perhaps you could create a page there for web developer documentation. We can link to it from the main page, like the XPCOM heading does higher up: both a link and a list of docs. There are a couple of web-dev-related items on the regular doc page already, as you noted, that I will link in shortly. There are more we could put there if we did a little organizing of the docs. We'll want to tighten things up, but go ahead and put the docs in this subdir and create an index page, and we can also promote the web developer heading on the regular docs page up a little higher. Does that sound OK? Note: also created an end-user subdir per conversation with endico.
dbaron, i think you should go for it. New docs that checked in that relate to pre-existing project should probably continue to be checked in with the rest of the project (like xul or js docs). But i'm sure there are plenty of web developer docs you can write that don't fit in anywhere else and they can be checked in this new directory. Also, m.o/web-developer/index.html can point to docs no matter where they live in the tree (and probably also to some of ekrock's docs on devedge).
I've checked in the web developer docs page and my DOM technotes. See http://www.mozilla.org/docs/web-developer/ . Do the changes attached above to http://www.mozilla.org/docs/ look OK?
After talking to endico about this on IRC, I checked in the changes to the main docs page to link to the new pages. Marking bug FIXED.
Status: ASSIGNED → RESOLVED
Closed: 25 years ago
Resolution: --- → FIXED
v
Status: RESOLVED → VERIFIED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: