[ruby-talk:02958] RUBY NEWSGROUP FAQ -- Rough draft.

Hi,

Here's the previously proposed Ruby Newsgroup FAQ.

The idea is to post it every couple of weeks or so for the benefit of
newcomers to comp.lang.ruby.

Feedback welcome -- remember that we want to keep it brief, if we keep it at
all.

Conrad

==================================

RUBY NEWSGROUP FAQ -- Welcome to comp.lang.ruby!

(Last modified on 2000-05-24.)

This FAQ contains information for those who want to

  1) learn more about Ruby, and to
  2) post to comp.lang.ruby.

1 About Ruby.

1.1 What is Ruby?

    Ruby is a relatively new, very high level, fully OO language that
    integrated many good ideas from Perl, Python, Smalltalk, Eiffel,
    ADA, Clu, and Lisp. Ruby is a relatively easy to learn and easy to
    read language, yet it is very powerful and sophisticated. For many
    of us, Ruby is "better Perl than Perl" and a "better Python than
    Python". You could characterize the Ruby philosophy as "there's a
    better way to do it" (TABWTDI).

1.2 Where can I find out more about Ruby?

    Ruby home page:

        http://www.ruby-lang.org

        Follow the links to documentation, downloads, the Ruby
        application archive, the Ruby mail list archives, and lots of
        other interesting information.

    Ruby FAQ:

        http://www.rubycentral.com/ref/

    Ruby classes, modules, and methods reference:

        http://www.rubycentral.com/ref/

2 About comp.lang.ruby.

2.1 Tell me about comp.lang.ruby.

    comp.lang.ruby was officially approved in early June, 2000. Here
    is the official charter:

    CHARTER: comp.lang.ruby

    The comp.lang.ruby newsgroup is devoted to discussions of the Ruby
    programming language and related issues.

    Examples of relevant postings include, but are not be limited to,
    the following subjects:

    - Bug reports
    - Announcements of software written with Ruby
    - Examples of Ruby code
    - Suggestions for Ruby developers
    - Requests for help from new Ruby programmers

    The newsgroup is not moderated.  Binaries are prohibited (except
    the small PGP type). Advertising is prohibited (except for
    announcements of new Ruby-related products).

    END CHARTER.

2.2 Tell me about the prolific Matz poster.

    Matz is the wizard that created Ruby. Be nice to him. See the
    Ruby home page to find out more.

2.3 Tell me the posting guidelines for comp.lang.ruby.

    (1) First of all, be considerate: don't be too lazy. If you are
        seeking information, first make a reasonable effort to look it
        up. As appropriate, check the Ruby home page, check the Ruby
        FAQ and other documentation, use deja.com to search past
        comp.lang.ruby postings and so on.

    (2) Make the subject line maximally informative, so that people
        who should be interested will read your post and so that people
        who wouldn't be interested can easily avoid it.

        (a) Start with one of these keywords if appropriate:

            ANNOUNCE -- new Ruby code, docs, or URLs of interest.
            BUG      -- report a definite bug.
            ERROR    -- report an error; don't know if it's a bug.
            JOB      -- advertise a Ruby-related job.
            OT       -- off topic.
            PRODUCT  -- advertise a Ruby-related product.

        (b) Describe the contents of your post:

            This is OK:

                "How can I do x with y on z?"
                "Bug: doing x with module y crashed z"

            This is NOT OK:

                "Newbie question"
                "Need Ruby guru to tell me what's wrong"

        (c) If reporting a problem, give all the relevant information;
            this isn't the psychic friends newsgroup. When
            appropriate, include:

            - The version of Ruby.
            - The compiler version used to build Ruby.
            - The OS type and level.
            - The actual error messages.
            - A simple example that produces the problem.

3. Where does this FAQ end?

    Right about here for the time being. Meanwhile, remember that one
    of the reasons that Ruby was designed to be relatively simple,
    uniform, yet very powerful was to make programming fun. Enjoy. :-)