306279 - Documentation on disabling self registration is incomplete (aka "how to disable user account creation?")

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Jochen Wiedmann]

User-Agent:       Mozilla/5.0 (X11; U; Linux i686; de-DE; rv:1.7.10) Gecko/20050720 Fedora/1.0.6-1.1.fc4 Firefox/1.0.6
Build Identifier: Mozilla/5.0 (X11; U; Linux i686; de-DE; rv:1.7.10) Gecko/20050720 Fedora/1.0.6-1.1.fc4 Firefox/1.0.6

The question on disabling self registration is poorly documented, because one
would hardly look at the "createemailregexp" parameter for that. The attached
patches are suggestions for clarifying the solution.


Reproducible: Always

Steps to Reproduce:

Comment 1

[Jochen Wiedmann]

Attachment: FAQ patch

Comment 2

[Jochen Wiedmann]

Attachment: Patch for the documentation of the "requirelogin" parameter.

Comment 3

[Olav Vitters]

Thanks for these patches. Please request review, see
http://www.bugzilla.org/docs/contributor.html.

Comment 4

[Erik Stambaugh]

Comment on attachment 194139 [details] [diff] [review]
Patch for the documentation of the "requirelogin" parameter.


>+           'Note, that users are still able to register themselves, ' .
		  ^--  remove this comma

>+           ' thus gaining access to the system. If you do not want' .
>+           ' that, set the "createemailregexp" parameter to the' .
>+           ' empty string.',

Seems fair.  It's a little redundant since createemailregexp is already
explained, but I guess I can see how people can get the wrong idea about what
requirelogin does.

It does seem a little wordy to me, though.  Personally, I'd say:

       To keep users from creating their own logins, use the
"createemailregexp" parameter.

...and be done with it, but I don't think I'd hang this patch up because of
that.  The comma bothers me enough to, though.	Fix that and I'm happy.

Comment 5

[Jochen Wiedmann]

Attachment: Updated patch for documenting the "requirelogin" parameter

Comment 6

[Frédéric Buclin]

Comment on attachment 197077 [details] [diff] [review]
Updated patch for documenting the "requirelogin" parameter

defparams.pl no longer exists

Comment 7

[Colin Ogilvie [:cso]]

Comment on attachment 194138 [details] [diff] [review]
FAQ patch

>+      <qandaentry>
>+        <question id="faq-phb-disableSelfRegistration">
>+          <para>
>+            I do not want, that users can register themselves. How do
>+            I disable that?
>+          </para>
>+        </question>

I think I'd prefer the question to be something similar to:

"I do not want users to be able to create their own accounts. Is it possible to disable the ablity for them to do so"

As it currently stands, the question doesn't make much sense to me.

I think it would then be best to answer it in this context...

>+        <answer>
>+          <para>
>+            This question typically comes up in connection with the
>+            parameter "requireLogin": Making bugs invisible to
>+            unregistered users still leaves the possibility that
>+            a user simply registers himself.
>+          </para>
>+          <para>
>+            Setting the parameter "createemailregexp" (Do not mismatch
>+            this with "emailregexp"!) to the empty string does what
>+            you want.
>+          </para>
>+        </answer>
>+      </qandaentry>
>     </qandadiv>

Comment 8

[Frédéric Buclin]

*** Bug 336005 has been marked as a duplicate of this bug. ***

Comment 9

[Frédéric Buclin]

http://www.bugzilla.org/docs/tip/html/useradmin.html and http://www.bugzilla.org/docs/tip/html/myaccount.html should be updated.

Updating the summary to find this bug more easily.

Comment 10

[timeless]

Comment on attachment 197077 [details] [diff] [review]
Updated patch for documenting the "requirelogin" parameter

>+           ' by creating own logins, unless the "createemailregexp" .

by creating _their_ own /accounts/, ...

Comment 11

[victory <[e-mail]>]

Attachment: patch for tip

i didn't change FAQ answer section ;-p

Comment 12

[Frédéric Buclin]

Colin, could you have a look at this patch? I think this bug is a "mustfix" for 3.0 as we regularly have many requests on IRC about how to do that.

Comment 13

[timeless]

Comment on attachment 236037 [details] [diff] [review]
patch for tip

>Index: docs/xml/faq.xml
>+        <question id="faq-phb-disableSelfRegistration">
>+            I do not want users to be able to create their own accounts.
>+            How do I prevent users from that?

from _doing_ that?.

>+            This question typically comes up in connection with the
>+            parameter "requireLogin": Making bugs invisible to
>+            unregistered users still leaves the possibility that
>+            a user simply registers himself.

simply /creates an account/. -- this avoids gender issues.

>+            Setting the parameter "createemailregexp" (Do not mismatch

Do not /confuse/

>+            this with "emailregexp"!) to the empty string does what
>+            you want.

>Index: docs/xml/using.xml
>+      Note that the <quote>Open a new Bugzilla account</quote> link
>+      may not exist if the bugzilla's admins disable users' self
>+      registration.  In this case contact the admins to make your account.

contact the admins to /request an/ account.

Comment 14

[Frédéric Buclin]

I fixed this doc as part of the docs patch from bug 119485.