661300 - Create release notes for Add-on SDK 1.0

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P1)

Description

[David Mason [:dcm :dmason]]

We must create release notes for the 1.0 release. We can start by going through past release notes and using the most pertinent items.

Comment 1

[Will Bamberg [:wbamberg]]

So far our release notes have concentrated on:
- what's new in this release
- what issues are still present in this release

Should that still be the format of these release notes, even thought they are for 1.0? (I would expect that yes, it should.)

Comment 2

[David Mason [:dcm :dmason]]

Yes, I think that is part of it - but also, I think it should have a good overview of what jetpack is within the release notes. Not a huge marketing scribe - but just an overview.

Comment 3

[Myk Melez [:myk] [@mykmelez]]

(In reply to comment #1)
> - what's new in this release

For this release, this section should be a more comprehensive look at the overall featureset of the product rather than a comparison with 1.0b5, since we expect the majority of 1.0's users to be completely new to the product.

(I expect this will hold for future releases... beta release notes will be for beta track developers and explain what has changed between beta releases, while stable release notes will be for stable track developers and explain what has changed between stable releases.)

Comment 4

[Will Bamberg [:wbamberg]]

Attachment: Drafted some release notes

Let me know if you think this is a reasonable level of detail. For "Known Issues" I just skimmed through all P2 or above bugs, and picked the ones that seemed most likely to be encountered by users.

Comment 5

[Will Bamberg [:wbamberg]]

Attachment: Drafted some release notes, again

Comment 6

[David Mason [:dcm :dmason]]

r+

... with one small nit-pick. Lets make the known issues bugs at least one size smaller. They stand out way too much.

Thanks Will!

Comment 7

[Will Bamberg [:wbamberg]]

(In reply to comment #6)
> r+
> 
> ... with one small nit-pick. Lets make the known issues bugs at least one
> size smaller. They stand out way too much.

Thanks. I'm not certain whether I've included too many known bugs here. I just removed bug 658592 on the basis that it's more like an enhancement than anything defective, but all the others seem to me something (1) clearly defective that are (2) fairly likely to be encountered by developers.