User:jenzed

  • Revision slug: User:jenzed
  • Revision title: User:jenzed
  • Revision id: 125907
  • Created:
  • Creator: jenzed
  • Is current revision? No
  • Comment 10 words added

Revision Content

temp_image_jen.jpgI'm Jennifer Zickerman. I am working on the Thunderbird documentation, auditing and organizing the existing stuff, identifying gaps and finding people to help fill them. Please contact me with your ideas and suggestions.

(Trivia: In Canada, the letter "Z" is pronounced "zed". Therefore I am "jen" + "zed")

Improvements to add-on docs for Thunderbird 3 release

Planning

Improvements to add-on docs for Thunderbird 3 release

Objective

We need to provide better documentation so that people can write add-ons for Thunderbird. Currently, there are documents in many locations, of questionable relevance and accuracy. With this project, we will create a document set on http://developer.mozilla.org that will be the primary reference. The document structure will be organized; existing docs will be audited, updated and edited; new docs will be created to show developers how to do common tasks. (Caveat: we will prioritize a small list of common tasks and do these, and possibly create a call-to-action / template that contributors can use to add additional "how to" docs.)

Deadlines

April 16: finish plan (this document); submit for feedback from internal folks
April 17/18: incorporate feedback; submit for feedback from community
...others TBD...
... final by TB 3.0 release ...

Approach

  1. (jen) Review existing docs
  2. (jen) Propose better structure / deployment
  3. (jen / MoMo / community) Identify gaps; prioritize
  4. (jen / MoMo / community) Technically validate existing articles
  5. (jen / MoMo / community) Write new articles to fill prioritized gaps
  6. (jen / MoMo / community) Update existing articles
  7. (jen) Implement structure / deployment plan
  8. (jen) Edit the whole shebang
  9. (jen) Add comments / notices to articles that talk about TB extensions on Mozillazine, various blogs, PlanetMoz, etc, pointing to the updated docs on MDC
  10. (jen) Wag tail

Questions

  • What are the high-level intentions regarding developer.mozilla.org versus www.mozilla.org versus wiki.mozilla.org? Are the following statements correct:
    • www.mozilla.org is gradually being retired as a developer documentation site and things are being gradually ported to developer.mozilla.org?
    • www.mozilla.org will be the user documentation site?
    • wiki.mozilla.org is the project management site - there probably shouldn't be any documentation here, just links?
    • It seems that www.mozilla.org is used for "core" docs (instructions for build, localization, etc). Is this as desired?

developer.mozilla.org

Main Page (https://developer.mozilla.org/en/)

Trivia:

  • change "Extensions" page to "Extensions / Add-ons"? (to standardize terminology) (Or is this not really a problem?)
  • standardize on "addons" or "add-ons"? (I know, I know...) (already in style guide?)
  • Why is "Documentation" heading a site tag?
Main Page | Extensions (https://developer.mozilla.org/en/Extensions)

Reorganize page:

==General==

I think there are enough similarities in extension development for Firefox and Thunderbird that the following documents should be "generic" - that is, a single document should cover the topic for both Firefox and Thunderbird (with application-specific sections as necessary).

  • (review / make generic) Setting up extension development environment
  • (review / make generic) Extension Packaging
  • (review / make generic) Installing extensions ( -> Installing / Uninstalling extensions) (do we have existing uninstalling info?)
  • (review / make generic) Extension Frequently Asked Questions
  • (review / make generic) Submitting an add-on to AMO
  • (review / make generic) Code snippets

==Firefox==

  • Firefox addons developer guide
  • Creating Custom Firefox Extensions with the Mozilla Build System
  • Updating extensions for Firefox 3
  • Updating extensions for Firefox 3.5
  • Building an Extension ( -> Building a Firefox extension)

==Thunderbird==

  • (review / update) Building a Thunderbird extension (developer.mozilla.org/en/Building_a_Thunderbird_extension)
  • (new) Developer resources (STEEL, FUEL, GLODA)
  • (new) How to muck around with the folder pane
  • (new) How to muck around with the message view
  • (new) How to muck around with the message list
  • (new) How to add a new tab
  • (new) How to add a column

(many potential topics here - Sheppie also has a list at https://developer.mozilla.org/User:Sheppy/Thunderbird_documentation_list under "Thunderbird architecture" - need to prioritize)

==SeaMonkey==

  • Updating extensions for SeaMonkey 2.0

Other

Tidy up our own pages; point to new / reworked stuff.

Problems with "Building a Thunderbird Extension" tutorial

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

  • "{3550f703-e582-4d05-9a08-453d09bdfdc6} - Thunderbird's application ID. Without this exact number it will not install. (Note: this ID is not Thunderbird's current application ID)" - huh? how to determine current? phrase this better
  • "The application is implemented in a XUL file called messenger.xul ($THUNDERBIRD_INSTALL_DIR/chrome/messenger.jar contains content/messenger/messenger.xul)" - confusing - note that this is the existing TB installation (in case people don't understand the variable usage)
  • "spamato" references - it seems like this tutorial was kluged from something else that is related to another extension, which seems irrelevant . Can it be changed so that the tutorial is a straight-forward extension to a standard installation? Like a simple new menu item?
  • "Take the code for the sample.xul file above" - there is no sample.xul above, only below.
  • formatting problems in "Registering an Overlay" section - this should be a code block to prevent display of the link icons
  • the first numbered section in the "Test" section - these should be bullets, not numbers (as they seem to be alternatives, not steps)
  • steps are in the wrong order - the test section occurs before the section that tells you how to make the xpi
  • " However, since Mac OS X adds hidden files to folders in order to track file metadata" - why does this matter? How does it harm the process?

Preliminary planning notes

(preliminary planning notes derived from chats with David Ascher, Sheppy, David Bienvienu and Dan Mosedale)

1. Infrastructure and process

1.1 Doc set

- "meta" docs
    - packaging extensions
    - "philosophy"
        - patch rather than workaround
        - extensions

1.2 What goes where? Deployment plan

- what goes where?

1.2.1 Existing sites

- developer.mozilla.org

- www.mozillamessaging.com

- kb.mozillazine.org

- http://www.mozilla.org/projects/thun...xtensions.html

1.3 Existing docs

- stuff that's hidden away
- leverage existing Firefox docs

1.4 Consulting group

- Eric, Dan, David, David
- do we need a committee? (gak) if so, who?

1.5 Objectives

- why are we doing this? what are we trying to achieve?

2. Requirements / gap analysis

3. TODO list / assignments and contributors / deadlines

3.1 Requirements

- list required articles

3.2 Contributors

- David Bienvenu, ...

4. Deployment

- editing
- linking
- identifying update triggers

Contact info

Email: jen at mozillamessaging dot com
IRC: jenzed
Blog: tbd

Revision Source

<p><img alt="temp_image_jen.jpg" class="internal default" src="/@api/deki/files/3424/=temp_image_jen.jpg" style="width: 186px; height: 96px;">I'm Jennifer Zickerman. I am working on the Thunderbird documentation, auditing and organizing the existing stuff, identifying gaps and finding people to help fill them. Please contact me with your ideas and suggestions.</p>
<p>(Trivia: In Canada, the letter "Z" is pronounced "zed". Therefore I am "jen" + "zed")</p>
<p><a class="internal" href="/User:Jenzed/Improvements_to_add-on_docs_for_Thunderbird_3_release" title="User:Jenzed/Improvements to add-on docs for Thunderbird 3 release">Improvements to add-on docs for Thunderbird 3 release</a></p>
<h2>Planning</h2>
<h3>Improvements to add-on docs for Thunderbird 3 release</h3>
<h4>Objective</h4>
<p>We need to provide better documentation so that people can write add-ons for Thunderbird. Currently, there are documents in many locations, of questionable relevance and accuracy. With this project, we will create a document set on <a class=" external" href="http://developer.mozilla.org" rel="freelink">http://developer.mozilla.org</a> that will be the primary reference. The document structure will be organized; existing docs will be audited, updated and edited; new docs will be created to show developers how to do common tasks. (Caveat: we will prioritize a small list of common tasks and do these, and possibly create a call-to-action / template that contributors can use to add additional "how to" docs.)</p>
<h4>Deadlines</h4>
<p>April 16: finish plan (this document); submit for feedback from internal folks<br>
April 17/18: incorporate feedback; submit for feedback from community<br>
...others TBD...<br>
... final by TB 3.0 release ...</p>
<h4>Approach</h4>
<ol> <li>(jen) Review existing docs</li> <li>(jen) Propose better structure / deployment</li> <li>(jen / MoMo / community) Identify gaps; prioritize</li> <li>(jen / MoMo / community) Technically validate existing articles</li> <li>(jen / MoMo / community) Write new articles to fill prioritized gaps</li> <li>(jen / MoMo / community) Update existing articles</li> <li>(jen) Implement structure / deployment plan</li> <li>(jen) Edit the whole shebang</li> <li>(jen) Add comments / notices to articles that talk about TB extensions on Mozillazine, various blogs, PlanetMoz, etc, pointing to the updated docs on MDC</li> <li>(jen) Wag tail</li>
</ol>
<h4>Questions</h4>
<ul> <li>What are the high-level intentions regarding developer.mozilla.org versus www.mozilla.org versus wiki.mozilla.org? Are the following statements correct: <ul> <li>www.mozilla.org is gradually being retired as a developer documentation site and things are being gradually ported to developer.mozilla.org?</li> <li>www.mozilla.org will be the user documentation site?</li> <li>wiki.mozilla.org is the project management site - there probably shouldn't be any documentation here, just links?</li> <li>It seems that www.mozilla.org is used for "core" docs (instructions for build, localization, etc). Is this as desired?</li> </ul> </li>
</ul>
<h4>developer.mozilla.org</h4>
<h5>Main Page (https://developer.mozilla.org/en/)</h5>
<p>Trivia:</p>
<ul> <li>change "Extensions" page to "Extensions / Add-ons"? (to standardize terminology) (Or is this not really a problem?)</li> <li>standardize on "addons" or "add-ons"? (I know, I know...) (already in style guide?)</li> <li>Why is "Documentation" heading a site tag?</li>
</ul>
<h5>Main Page | Extensions (https://developer.mozilla.org/en/Extensions)</h5>
<p>Reorganize page:<br>
<br>
==General==</p>
<p>I think there are enough similarities in extension development for Firefox and Thunderbird that the following documents should be "generic" - that is, a single document should cover the topic for both Firefox and Thunderbird (with application-specific sections as necessary).</p>
<ul> <li>(review / make generic) Setting up extension development environment</li> <li>(review / make generic) Extension Packaging</li> <li>(review / make generic) Installing extensions ( -&gt; Installing / Uninstalling extensions) (do we have existing uninstalling info?)</li> <li>(review / make generic) Extension Frequently Asked Questions</li> <li>(review / make generic) Submitting an add-on to AMO</li> <li>(review / make generic) Code snippets</li>
</ul>
<p>==Firefox==</p>
<ul> <li>Firefox addons developer guide</li> <li>Creating Custom Firefox Extensions with the Mozilla Build System</li> <li>Updating extensions for Firefox 3</li> <li>Updating extensions for Firefox 3.5</li> <li>Building an Extension ( -&gt; Building a Firefox extension)</li>
</ul>
<p>==Thunderbird==</p>
<ul> <li>(review / update) Building a Thunderbird extension (developer.mozilla.org/en/Building_a_Thunderbird_extension)</li> <li>(new) Developer resources (STEEL, FUEL, GLODA)</li> <li>(new) How to muck around with the folder pane</li> <li>(new) How to muck around with the message view</li> <li>(new) How to muck around with the message list</li> <li>(new) How to add a new tab</li> <li>(new) How to add a column</li>
</ul>
<p>(many potential topics here - Sheppie also has a list at https://developer.mozilla.org/User:Sheppy/Thunderbird_documentation_list under "Thunderbird architecture" - need to prioritize)</p>
<p>==SeaMonkey==</p>
<ul> <li>Updating extensions for SeaMonkey 2.0</li>
</ul>
<h4>Other</h4>
<p>Tidy up our own pages; point to new / reworked stuff.</p>
<ul> <li><a class=" external" href="http://forums.mozillazine.org/viewtopic.php?t=424455&amp;highlight=thunderbird+overlay" rel="freelink">http://forums.mozillazine.org/viewto...erbird+overlay</a></li> <li><a class=" link-https" href="https://wiki.mozilla.org/Thunderbird:Extensions" rel="freelink">https://wiki.mozilla.org/Thunderbird:Extensions</a> (remove "TBD")</li> <li>"Extensions" section on <a class=" external" href="http://www.mozilla.org/projects/thunderbird/specs/extensions.html" rel="freelink">http://www.mozilla.org/projects/thun...xtensions.html</a> - point to developer.mozilla.org/en/Extensions</li> <li> <p><a class=" external" href="http://kb.mozillazine.org" rel="freelink">http://kb.mozillazine.org</a> (various)</p> </li>
</ul>
<h3>Problems with "Building a Thunderbird Extension" tutorial</h3>
<p>https://developer.mozilla.org/en/Building_a_Thunderbird_extension</p>
<ul> <li>"{3550f703-e582-4d05-9a08-453d09bdfdc6} - Thunderbird's application ID. Without this exact number it will not install. (Note: this ID is not Thunderbird's current application ID)" - huh? how to determine current? phrase this better</li> <li>"The application is implemented in a XUL file called messenger.xul ($THUNDERBIRD_INSTALL_DIR/chrome/messenger.jar contains content/messenger/messenger.xul)" - confusing - note that this is the existing TB installation (in case people don't understand the variable usage)</li> <li>"spamato" references - it seems like this tutorial was kluged from something else that is related to another extension, which seems irrelevant . Can it be changed so that the tutorial is a straight-forward extension to a standard installation? Like a simple new menu item?</li> <li>"Take the code for the sample.xul file above" - there is no sample.xul above, only below.</li> <li>formatting problems in "Registering an Overlay" section - this should be a code block to prevent display of the link icons</li> <li>the first numbered section in the "Test" section - these should be bullets, not numbers (as they seem to be alternatives, not steps)</li> <li>steps are in the wrong order - the test section occurs before the section that tells you how to make the xpi</li> <li>" However, since Mac OS X adds hidden files to folders in order to track file metadata" - why does this matter? How does it harm the process?</li>
</ul>
<h3>Preliminary planning notes</h3>
<p>(preliminary planning notes derived from chats with David Ascher, Sheppy, David Bienvienu and Dan Mosedale)</p>
<p>1. Infrastructure and process<br>
<br>
1.1 Doc set<br>
<br>
- "meta" docs<br>
    - packaging extensions<br>
    - "philosophy"<br>
        - patch rather than workaround<br>
        - extensions <br>
<br>
1.2 What goes where? Deployment plan<br>
<br>
- what goes where?</p>
<p>1.2.1 Existing sites<br>
<br>
- developer.mozilla.org<br>
<br>
- www.mozillamessaging.com<br>
<br>
- kb.mozillazine.org</p>
<p>- <a class=" external" href="http://www.mozilla.org/projects/thunderbird/specs/extensions.html" rel="freelink">http://www.mozilla.org/projects/thun...xtensions.html</a><br>
<br>
1.3 Existing docs<br>
<br>
- stuff that's hidden away<br>
- leverage existing Firefox docs<br>
<br>
1.4 Consulting group<br>
<br>
- Eric, Dan, David, David<br>
- do we need a committee? (gak) if so, who?<br>
<br>
1.5 Objectives<br>
<br>
- why are we doing this? what are we trying to achieve?<br>
<br>
2. Requirements / gap analysis<br>
<br>
3. TODO list / assignments and contributors / deadlines <br>
<br>
3.1 Requirements<br>
<br>
- list required articles<br>
<br>
3.2 Contributors<br>
<br>
- David Bienvenu, ...<br>
<br>
4. Deployment<br>
<br>
- editing<br>
- linking<br>
- identifying update triggers</p>
<h2>Contact info</h2>
<p><strong>Email</strong>: jen at mozillamessaging dot com<br>
<strong>IRC</strong>: jenzed<br>
<strong>Blog</strong>: tbd</p>
Revert to this revision