Hi all,
In the discussion about renaming/replacing this group, a few of us
mentioned a FAQ. If there's a FAQ somewhere, it's reasonably well
hidden. :-) In that other thread, kangax wrote:
> I have started on a FAQ some time ago. It's fairly basic, but could be
> a good start
Excellent! We have a starting point (and knowing kangax, his
"starting point" is probably where most people thing "Yeah, okay,
that's good enough for now.").
In terms of hosting it and keeping it possible for people to improve
it, I see a couple of options:
1. Fairly obvious, we could host the FAQ on Google Groups as a "page"
attached to the users group and allow either members or (if there's a
problem with malicious edits) managers to edit it.
Pros: A) It's attached to the group and so quite easy to find if
you're using the web interface; B) Google Groups pages are fairly easy
to edit; C) Groups provides reasonable controls over the pages along
with basic versioning; D) Same member/manager/owner stuff that applies
to the group applies to the pages.
Cons: A) The UI is nice for simple things but doesn't even provide a
means of doing preformatted sections or anchors, both of which seem
important for a code-related FAQ -- instead, you have to use the Edit
HTML feature; B) It's attached to the group, rather than to Prototype
(yes, I know that was also a "pro").
2. I can't help but notice that GitHub provides wikis for projects, so
if the core team want, we could put it somewhere on
http://github.com/sstephenson/prototype/wikis. I'm probably not
familiar enough with GitHub to do a proper pros and cons for it, but:
Pros: A) It's attached to Prototype rather than the group; B) It's a
proper wiki.
Cons: A) Completely different set of users and permissions (Git vs.
Group); B) Less obviously associated with the users group.
Off the cuff, I lean toward hosting it on the group's "pages" despite
the failings of Google's editor (I mean, we can all just about edit
HTML, right?). We can also use Pastie (
http://pastie.org) for
questions/answers involving any significant amount of code, although
usually it's oneliner stuff we can do inline.
I lean toward the pages rather than GitHub for two reasons: A) Having
the same members/managers/owner stuff for the FAQ as for the group
seems like a good idea, B) Of the two choices above, for me
associating it with the group (user land) rather than GitHub
(developer/committer land) makes sense.
Thoughts?
--
T.J. Crowder
tj / crowder software / com