356926 - contrib/README doesn't reflect reality

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Max Kanat-Alexander]

There's a README in the contrib/ directory that really needs to be updated to describe all the scripts in the directory.

Comment 1

[Sam Folk-Williams]

Attachment: add all the missing scripts/directories to file

Patch attached. Note one weirdness I'm seeing. contrib/ has a directory called bug-bugzilla/ which appears to be empty:

$ ls bug-bugzilla/
CVS

I have left this out of the README

Comment 3

[Vlad Dascalu]

Comment on attachment 284838 [details] [diff] [review]
add all the missing scripts/directories to file

+bugzilla_ldapsync.rb --  Script you can run via cron that queries an LDAP

Is "an" the correct thing to be used here? (why not "a"?)

+       cvs-update.pl --  Script to keep a record of all cvs updates made 

"all cvs" -> "all CVS"

+         gnats2bz.pl --  A perl script to help import bugs from a GNATS 

You said above "A Python" so this should be "A Perl" ("perl" -> "Perl")


Probably you just moved those around and they appear in the diff, but they still remain inconsistent.

If you could check the rest of the file for this sort of stuff it would be great!

Comment 4

[Sam Folk-Williams]

Attachment: Doc patch for 3.0 and 3.1, changes per vladd's comments

Thanks - I went through everything and tried to catch it all. Also removed "you" language. In terms of "an LDAP" vs "a LDAP" there was one instance of "an LDAP" already in there. I think this is correct but if you disagree feel free to change :)

Let me know if I missed anything else.

Comment 5

[Vlad Dascalu]

Comment on attachment 284936 [details] [diff] [review]
Doc patch for 3.0 and 3.1, changes per vladd's comments

I think 'cron' is ok as it is.

Thanks for the follow-up.

Comment 6

[Vlad Dascalu]

Can you set the target milestone according to the release for which you've written the documentation?

We need patches for each release that we support docs for (2.20, 2.22 and 3.0).

If the patch doesn't apply cleanly to those branches (or you've added stuff that went for example in 2.22) we'll need distinct versions of this patch for older targets.

Comment 7

[Frédéric Buclin]

Comment on attachment 284936 [details] [diff] [review]
Doc patch for 3.0 and 3.1, changes per vladd's comments

This patch applies to 3.0 and 3.1. I would say you don't *need* to update the README file for 2.20 and 2.22. But if you want to do it, this would be fine.

Comment 8

[Frédéric Buclin]

Pushing this patch in our radar for checkins. We can retarget it to 2.20 as soon as it has a patch ready.

Comment 9

[Frédéric Buclin]

tip:

Checking in contrib/README;
/cvsroot/mozilla/webtools/bugzilla/contrib/README,v  <--  README
new revision: 1.12; previous revision: 1.11
done

3.0.2:

Checking in contrib/README;
/cvsroot/mozilla/webtools/bugzilla/contrib/README,v  <--  README
new revision: 1.10.14.2; previous revision: 1.10.14.1
done