Implement a Welcome page for admins on a fresh installation

RESOLVED FIXED in Bugzilla 3.0

Status

()

--
enhancement
RESOLVED FIXED
12 years ago
12 years ago

People

(Reporter: LpSolit, Assigned: LpSolit)

Tracking

unspecified
Bugzilla 3.0
Bug Flags:
approval +

Details

(URL)

Attachments

(1 attachment, 1 obsolete attachment)

(Assignee)

Description

12 years ago
I was thinking about displaying some useful information to the admin the first time he logged in on a fresh installation. My criteria to determine what "fresh" means is that the 'urlbase' param is empty.

I attached a URL in the URL field pointing to such a page. You need admin privs on this installation to see it. As soon as urlbase is set, you will never see this page again (unless you reset urlbase).

Comments/feedback?
(Assignee)

Comment 1

12 years ago
Created attachment 234631 [details] [diff] [review]
patch, v1

First attempt. :)
Attachment #234631 - Flags: review?(mkanat)
Comment on attachment 234631 [details] [diff] [review]
patch, v1

This is brilliant and will answer many FAQs right from the start :)

Minor things only all in all:

>+  # The Initial Developer of the Original Code is Netscape Communications
>+  # Corporation. Portions created by Netscape are
>+  # Copyright (C) 1998 Netscape Communications Corporation. All
>+  # Rights Reserved.

This is only required where code needs to inherit it. New code doesn't get this, but "The Original Code is the Bugzilla Bug Tracking System" instead.

>+  <p>Welcome [% user.identity FILTER html %].<p>

Nit: place a comma after Welcome.

>+  <p>You see this page because some of the core parameters have not been set up yet.
>+  The goal of this page is to inform you about the very first steps required to set up
>+  your installation correctly.</p>

s/very first/next/, or maybe even s/very first/last/ -- if they're seeing this page, they have already done a lot of installation work.

>+    <li><a href="editparams.cgi?section=core#utf8">utf8</a> will let you encode all
>+    texts into UTF-8, if desired (it is strongly recommanded to have this parameters
>+    turned on).</li>

s/recommanded/recommended/, s/have/keep/ (it's on by default), and s/parameters/parameter/.

Hmmmm... I don't think new installations should consider looking at this parameter at all... I'd say we should drop it from this welcome page. What's your reason to include it?

>+    only an administrator will be  able to create one for them. If you want a private

As nitty as can be: there is a surplus space at "be  able" :)

>+    defines the method used to send emails, such as sendmail or SMTP. You have to set
>+    it correctly to receive emails.</li>

I think it's less confusing if you speak of Bugzilla sending e-mails here instead of the person receiving e-mails. The person reading this is very probably receiving e-mails all right.

>+  <p>Of course, there are many other parameters, but these ones are those you must
>+  absolutely have a look at.</p>

How about this: "After having set up all this, we recommend looking at Bugzilla's other parameters as well at some time so that you understand what they do and whether you want to modify their settings for your installation." or something along these lines?
Attachment #234631 - Flags: review?(mkanat) → review-

Comment 3

12 years ago
Comment on attachment 234631 [details] [diff] [review]
patch, v1

>+  <p>You see this page because some of the core parameters have not been set up yet.
>+  The goal of this page is to inform you about the very first steps required to set up
>+  your installation correctly.</p>

"You are seeing" reads better to me than "You see"
(Assignee)

Comment 4

12 years ago
Created attachment 234663 [details] [diff] [review]
patch, v1.1

Addressed all comments from Marc and Colin. About utf8, the confusing thing is that it's technically off by default:

  {
   name => 'utf8',
   type => 'b',
   default => '0',
  },

It's turned on for new installations in Config::update_params() (which is the case here). But I thought it would be useful to bring attention on this point in case update_params() failed to turn it on for some reason. I have no other reason. I can remove it if you want to, though.
Attachment #234631 - Attachment is obsolete: true
Attachment #234663 - Flags: review?(wurblzap)
Comment on attachment 234663 [details] [diff] [review]
patch, v1.1

r=Wurblzap by last review, interdiff and comment 4.
Attachment #234663 - Flags: review?(wurblzap) → review+
Flags: approval?
Flags: approval? → approval+
(Assignee)

Comment 6

12 years ago
Checking in index.cgi;
/cvsroot/mozilla/webtools/bugzilla/index.cgi,v  <--  index.cgi
new revision: 1.23; previous revision: 1.22
done
Checking in skins/standard/index.css;
/cvsroot/mozilla/webtools/bugzilla/skins/standard/index.css,v  <--  index.css
new revision: 1.5; previous revision: 1.4
done
RCS file: /cvsroot/mozilla/webtools/bugzilla/template/en/default/welcome-admin.html.tmpl,v
done
Checking in template/en/default/welcome-admin.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/welcome-admin.html.tmpl,v  <--  welcome-admin.html.tmpl
initial revision: 1.1
done
Status: NEW → RESOLVED
Last Resolved: 12 years ago
Keywords: relnote
Resolution: --- → FIXED

Comment 7

12 years ago
Added to the release notes on bug 255155.
Keywords: relnote

Comment 8

12 years ago
The correct bug number for those release notes is actually bug 349423.
You need to log in before you can comment on or make changes to this bug.