Skip to Content.
Sympa Menu

grouper-users - RE: [grouper-users] feedback on grouper documentation

Subject: Grouper Users - Open Discussion List

List archive

RE: [grouper-users] feedback on grouper documentation

Chronological Thread 
  • From: Chris Hyzer <>
  • To: Paul Gazda <>, Tom Barton <>, "" <>
  • Cc: Ann Kitalong-Will <>
  • Subject: RE: [grouper-users] feedback on grouper documentation
  • Date: Fri, 11 Jun 2010 11:22:45 -0400
  • Accept-language: en-US
  • Acceptlanguage: en-US

Thanks for the feedback. To respond to this directly, we switched from cvs
to svn, so links to source/javadoc in old docs don't work. I don't really
know what to do here, but a workaround is to look at the link, and see the
source file, and look at that in your grouper jar or your javadoc. You can
get to SVN from the latest Grouper Web Services doc, and go to the revision
in web svn of your branch or tag... not the most convenient, but it is
possible to find the information...

Not that it makes anyone feel better, but I think that link just links to the
file in svn, not the file that is tied to the particular branch/tag... it
seems too hard to maintain (too many links) to get this done perfectly...


-----Original Message-----
From: Paul Gazda

Sent: Friday, June 11, 2010 11:14 AM
To: Tom Barton;

Cc: Ann Kitalong-Will
Subject: RE: [grouper-users] feedback on grouper documentation

I haven't had to use the documentation lately, but I checked it out because
of this email and find it has improved tremendously since I first tried to
use it a couple of years ago. It seems easy to find what I want from the main
web page, and the pdf documentation is well organized. Very nice work!

However, I found one problem when I went to the 1.4.2 doc in the archives
(the version we are using). I looked at v1.4.0 Grouper Web Services, and
found the links to be out of date. For example, if I look at the Add Member
command section and click on any of the links in the section, I go to a page
saying "This has moved to". When I follow that link, I
just get a table of contents that doesn't mean anything to me. I assume the
links went to some specific place in the past, and it would be very helpful
to update them.

Paul Gazda

-----Original Message-----
From: Tom Barton

Sent: Wednesday, May 26, 2010 1:15 PM

Cc: Ann Kitalong-Will
Subject: [grouper-users] feedback on grouper documentation

Have you had a recent experience with needing to rely on grouper's
documentation for some purpose, and either couldn't find something you
needed or wish it would have been much easier to learn?

We will take an initial step to rework the grouper documentation wiki
over the next 3 months, and we'd very much like your feedback, positive
and negative, to help us identify the documentation needs we should
focus on. Our motivation is to make it easier for implementers and
others to find the information they need to help them with specific
tasks, such as installing, upgrading, or troubleshooting.

Ann Kitalong-Will, who supports some of the other Internet2 working
groups, will guide this effort. AnnKW will engage with the grouper
community on this list for this project.

So please do share your experience with us. We'd also be extremely
grateful if one or two of you would be willing to work more closely with
us as "documentation use case experts" to help us ensure that the
reworked documentation is effective for your use case. Please contact
AnnKW if you'd like to inquire about working with us in this capacity.

Tom Barton
on behalf of the grouper team

Archive powered by MHonArc 2.6.16.

Top of Page