286865 - Remove or Replace Win32 Code Changes Section as they are no longer required

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Colin Ogilvie [:cso]]

Now that Bug 277437 has landed, no code changes are required for Win32 support,
so the section should be removed or replaced.

Personally, I'd go for replaced at the moment (they can be removed in the next
version) since it existed up until now, but others may disagree

Comment 1

[Colin Ogilvie [:cso]]

Attachment: Replace Section

Replace this section of code.

Comment 2

[Colin Ogilvie [:cso]]

Attachment: Remove Section

Remove this section of code.

Comment 3

[:glob ✱]

you should add a note that for bugzilla to work on windows you require an
accessable SMTP server.

Comment 4

[Colin Ogilvie [:cso]]

Attachment: Replace Section v2

Replace Section and Add an Email section.

Comment 5

[Kevin Benton]

Comment on attachment 177969 [details] [diff] [review]
Replace Section v2

Colin - I would review- this if we are trying to include documentation for
older still supported versions, however, I would definitely support changing
the text style and putting it in a sidebar box.  I would also require an
explanation on how to add the SMTP server configuration to Bugzilla (as you
discuss in the update).  Otherwise, nice job.  Someone else feel free to
override my comments.

Comment 6

[:glob ✱]

> I would also require an explanation on how to add the SMTP server 
> configuration to Bugzilla (as you discuss in the update).

when you run checksetup on windows, it defaults to smtp and will prompt you for
an smtp server address.  i'm not sure if this requires explicit documentation.

Comment 7

[Jacob Steenhagen]

Generally speaking, we don't require that specific information on how to set
something up in a past version of Bugzilla remain in the current version of the
guide. We try to maintain the documentation for each version as long as we
maintain the code itself. So it's acceptable to mention that the information is
different in this version than it was in the past, but it's not a requirement to
keep the old info around (though the 2.16 branch should contain acurate
information).

Comment 8

[Colin Ogilvie [:cso]]

(In reply to comment #5)
> Colin - I would review- this if we are trying to include documentation for
> older still supported versions, however, I would definitely support changing
> the text style and putting it in a sidebar box.

I don't understand the sidebar box comment, and per what Jake said I don't think
the first bit is relevant.

> I would also require an 
> explanation on how to add the SMTP server configuration to Bugzilla (as you
> discuss in the update).

I am split on whether this should be mentioned or not, like byron.

Comment 9

[Kevin Benton]

Comment on attachment 177969 [details] [diff] [review]
Replace Section v2

Based on comments from others, it seems this looks good then.

Comment 10

[Frédéric Buclin]

Comment on attachment 177969 [details] [diff] [review]
Replace Section v2

glob, can you have a look at these changes in the docs about installing Bugzilla on Windows?

Comment 11

[:glob ✱]

Comment on attachment 177969 [details] [diff] [review]
Replace Section v2

r=glob

>+        <title>Code changes required to run on Win32</title>
[..]
>+          Bugzilla on win32 is supported out of the box from version 2.20; this
>+          means that no code changes are required to get Bugzilla running.

nit: you changed win32 to Win32, but used win32 in the blurb.

>+          To enable Bugzilla to send email on Windows, the server running the
>+          Bugzilla code must be able to connect to an SMTP server.

maybe replace "connect to" with "connect to or act as"?

people may thing that bugzilla needs to connect to an external smtp server.  *shrugs*

Comment 12

[Colin Ogilvie [:cso]]

Attachment: Patch v2.1

Comment 13

[Colin Ogilvie [:cso]]

Comment on attachment 202991 [details] [diff] [review]
Patch v2.1

Fix nits...

I was hoping that I could get a quick review of the Interdiff on IRC, but it wasn't particularly great, so I'll just ask glob to review it.

Comment 14

[:glob ✱]

Comment on attachment 202991 [details] [diff] [review]
Patch v2.1


r=glob -- assuming it applies cleanly ;)

>+  Bugzilla code must be able to connect to, or act as,  an SMTP server.

please remove double space on check-in.

Comment 15

[Colin Ogilvie [:cso]]

Trunk:

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <--  installation.xml
new revision: 1.105; previous revision: 1.104
done

2.20:

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <--  installation.xml
new revision: 1.98.2.7; previous revision: 1.98.2.6
done