494037 - Release Notes for Bugzilla 3.4rc1

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Max Kanat-Alexander]

The biggest thing we need for the 3.4rc1 release is Release Notes. This actually wasn't too hard for 3.2 (the Template Toolkit stuff makes it much easier), and I don't expect it to be impossibly hard for 3.4 either, particularly since 3.4 is such a smaller release than 3.2.

Comment 1

[Max Kanat-Alexander]

Hey manu, I know you mentioned that you wanted to work on relnotes. Are you working on these, or are you just working on the other smaller releases (which would be OK)? I just want to know, because we're just about ready to release 3.4rc1 and I'm going to do these release notes if you haven't started on them yet.

Comment 2

[Emmanuel Seyman]

(In reply to comment #1)
>
> Hey manu, I know you mentioned that you wanted to work on relnotes. Are you
> working on these, or are you just working on the other smaller releases (which
> would be OK)?

I'll only be able to start on Tuesday so it's probably best you go ahead.

Comment 3

[Max Kanat-Alexander]

Attachment: WIP

Here is a work in progress, containing most of the major features and code change notes.

Comment 4

[Max Kanat-Alexander]

Attachment: WIP 2

Added more features from bugs marked "relnote".

Comment 5

[Max Kanat-Alexander]

Attachment: WIP 3

Now contains some of the Outstanding Issues.

Comment 6

[Max Kanat-Alexander]

Attachment: v1

Comment 7

[Frédéric Buclin]

Comment on attachment 387336 [details] [diff] [review]
v1

>Index: template/en/default/pages/release-notes.html.tmpl

>+<h2><a name="v34_req">Minimum Requirements</a></h2>

This makes the title to be seen as an anchor. You must move </a> before the title.


>+<h3><a name="v34_feat_enter">Simple Bug Filing</a></h3>

Same problem here and for other <h3> titles.

Also, here and at several other places is "Bug" hardcoded, instead of $terms.Bug. This makes 009bugwords.t to fail.


>+<h3><a name="34_feat_see">"See Also" Field</a></h3>

The anchor name must start with "v34", not "34" alone.


>+  <li>When logging out, users are now redirected to the main page of
>+    [% terms.Bugzilla %] instead of an empty page.</li>

Must be [%+ ... %], else no whitespace is added before "Bugzilla". Either that or put "of" right before it.


>+  <li>If you input an invalid regular expression anywhere in
>+    [% terms.Bugzilla %], it will now tell you explicitly instead of failing
>+    cryptically.</li>

Same here.


>+<tr> <td>CGI</td>          <td class="req_new">3.21</td> </tr>

CGI 3.21 for Perl 5.8.x, but CGI 3.33 for Perl 5.10.x.


I didn't check all features one by one. I trust you listed them correctly. Everything looks good.

Comment 8

[Marc Schumann [:Wurblzap]]

+<p>Users can now select what time zone they are in and Bugzilla will
+  adjust displayed times to be correct for their time zone. However,
+  time zones the user inputs are unfortunately still in 

times the user inputs

+<p>Here's an example: Let's say that we create a field called "Colors",
+  and we make the Product field "control the values" for Colors. Then we
+  add Blue, Red, Black, and Yellow as legal values for the "Colors" field.
+  Now we can say that "Blue" and "Red" only appear as valid choices in 
+  Product A, "Yellow" only appears in Product B, but "Black" <em>always</em>
+  appears.</p>

Maybe this paragraph can be dropped, or replaced by "see the docs for details"?

Comment 9

[Max Kanat-Alexander]

(In reply to comment #7)
> >+<h2><a name="v34_req">Minimum Requirements</a></h2>
> 
> This makes the title to be seen as an anchor. You must move </a> before the
> title.

  This is a broader general regression in 3.4 that we need to fix, not a problem with the release notes. (We need to add a CSS rule for a[name].)

(In reply to comment #8)
> Maybe this paragraph can be dropped, or replaced by "see the docs for details"?

  I don't think there are any docs. The problem is that the paragraph above is pretty much incomprehensible, even to me, and I wrote it. It's the nature of the logic of the thing, not the writing, I think.

Comment 10

[Max Kanat-Alexander]

Attachment: v2

Address LpSolit and Wurblzap's comments, fix bugwords test failures, and fix HTML validation.

Comment 11

[Max Kanat-Alexander]

Attachment: Actual v2

Accidentally uploaded the wrong one.

Comment 12

[Frédéric Buclin]

Comment on attachment 387408 [details] [diff] [review]
Actual v2

Looks good. r=LpSolit

Comment 13

[Max Kanat-Alexander]

I've checked in the release notes as they are, but I will still take review comments from anybody who wants to point out errors or improvements, and check in the fixes afterward.

tip:

Checking in docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm;
/cvsroot/mozilla/webtools/bugzilla/docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm,v  <--  Bugzilla.pm
new revision: 1.6; previous revision: 1.5
done
Checking in template/en/default/pages/release-notes.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/pages/release-notes.html.tmpl,v  <--  release-notes.html.tmpl
new revision: 1.36; previous revision: 1.35
done

3.4:

Checking in docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm;
/cvsroot/mozilla/webtools/bugzilla/docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm,v  <--  Bugzilla.pm
new revision: 1.5.2.1; previous revision: 1.5
done
Checking in template/en/default/pages/release-notes.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/pages/release-notes.html.tmpl,v  <--  release-notes.html.tmpl
new revision: 1.33.2.3; previous revision: 1.33.2.2
done