397665 - "Assigning Group Controls to Products" doesn't explain editcomponents, canconfirm, editbugs

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[bigstijn]

User-Agent:       Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 1.0.3705; InfoPath.1; .NET CLR 2.0.50727)
Build Identifier: Bugzilla 3.0

"Assigning Group Controls to Products" doesn't explain editcomponents, canconfirm, editbugs.

Although this is explained on editproducts.cgi?action=editgroupcontrols , it would be a good idea to explain this also in the documentation.

In that way, documentation is also aligned with http://www.bugzilla.org/releases/3.0/new-features.html#v30_feat_ppp

Ps: 
- Probably it's also a good idea to explain explicit the difference between "canedit" and "editbugs" rights.
- "Note that group permissions are such that you need to be a member of all the groups a bug is in, for whatever reason, to see that bug." : this isn't true anymore for the editcomponents, canconfirm and editbugs permissions.

Reproducible: Always

Comment 1

[Sam Folk-Williams]

I'm working on this - the whole section needs some work in light of the new features.

Comment 2

[Frédéric Buclin]

Sam, maybe this part of the doc should be moved to http://www.bugzilla.org/docs/3.0/html/products.html as that's the place where an administrator would find it, i.e. when editing products, not groups. And in the doc about groups, we should have a link pointing to the doc about products.

Comment 3

[Sam Folk-Williams]

Attachment: initial patch

This patch attempts to integrate the in-product docs with the manual. In addition, it moves this section to the product section rather than the group section (it alsofixes some "" vs <quote> errors).

A few questions - 

- I'm sure there are issues with the patch, please review and provide feedback.
- I'm not sure how to do a relative link from one place in the docs to another for the Groups section where this used to be
- I'm not sure if the new section in products should be a nested section or it's own section. I went with nested here.

Thanks,
Sam

Comment 4

[Frédéric Buclin]

(In reply to comment #3)
> - I'm not sure how to do a relative link from one place in the docs to another
> for the Groups section where this used to be

Write <xref linkend="id_of_the_section"/>.

Comment 5

[Sam Folk-Williams]

Attachment: added relative link

Thanks - added link

Comment 6

[Frédéric Buclin]

Comment on attachment 286506 [details] [diff] [review]
added relative link

Looks good to me, but I didn't try to compile it (Colin is trying to, though). r=LpSolit

Comment 7

[Colin Ogilvie [:cso]]

Comment on attachment 286506 [details] [diff] [review]
added relative link

patch: **** malformed patch at line 238:        <section>


Please put:

<para>
-----TEXT-----
</para>

<para>
-----TEXT-----
</para>

instead of it on the same line.

Comment 8

[Sam Folk-Williams]

Attachment: fixing malformed patch, para tags

Comment 9

[Sam Folk-Williams]

(In reply to comment #8)
> Created an attachment (id=287431) [details]
> fixing malformed patch, para tags
> 

I also took out the essentially useless information about the things that are not yet explained in the manual. There is another bug open to fix those (bug 400677)

Comment 10

[Colin Ogilvie [:cso]]

Comment on attachment 287431 [details] [diff] [review]
fixing malformed patch, para tags

>Index: docs/xml/administration.xml

>+      If any group has <strong>Entry</strong> selected, then the 
>+      product will restrict bug entry to only those users 
>+      who are members of all the groups with 
>+      <strong>Entry</strong> selected.

jade:../xml/administration.xml:736:30:E: element "strong" undefined
jade:../xml/administration.xml:739:13:E: element "strong" undefined

And repeat for future uses of strong :)


>+     <title>Assigning Group Controls to Products</title>
>+     <para>
>+     For information on assigning group controls to
>+     products, see the <xref linkend="products">products</xref>  

xref is an empty element, so doesn't take any content.

>+     section of the manual.
>+     </para>
>     </section>
>+
>+    <section>    
>     <section>


Don't think you need the extra section tag there?

Comment 11

[Sam Folk-Williams]

Attachment: fixing based on colin's notes

Comment 12

[Colin Ogilvie [:cso]]

Comment on attachment 287447 [details] [diff] [review]
fixing based on colin's notes

r=me for the XML.

Let lpsolit just check over the content once more.

Comment 13

[Frédéric Buclin]

Comment on attachment 287447 [details] [diff] [review]
fixing based on colin's notes


>+    <para>
>+    To create a new product:
>+    </para>
> 
>     <orderedlist>
>       <listitem>
>-        <para>Select "products" from the footer</para>
>+        <para> 
>+        Select <quote>products</quote> from the footer.
>+        </para>

Nit: in 3.1+, you have to click the "Administration" link from the footer, *then* the products link from the main admin page. In 3.0, this string is correct.

r=LpSolit with this nit fixed on tip. Colin, can you commit this patch?

Comment 14

[Colin Ogilvie [:cso]]

Checked in...

Checking in bugzilla-3.0/docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.70.2.5; previous revision: 1.70.2.4
done

Checking in bugzilla-trunk/docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.77; previous revision: 1.76
done