From e8970141039b8ab99c1b7fe3f54d2072dace62de Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 6 Dec 2009 21:37:39 -0800 Subject: doc: add ISSUES document --- .document | 1 + ISSUES | 36 ++++++++++++++++++++++++++++++++++++ KNOWN_ISSUES | 3 +++ README | 20 ++++++++------------ 4 files changed, 48 insertions(+), 12 deletions(-) create mode 100644 ISSUES diff --git a/.document b/.document index 86f3740..2156af2 100644 --- a/.document +++ b/.document @@ -15,3 +15,4 @@ lib ext/unicorn_http/unicorn_http.c unicorn.1 unicorn_rails.1 +ISSUES diff --git a/ISSUES b/ISSUES new file mode 100644 index 0000000..a0d620b --- /dev/null +++ b/ISSUES @@ -0,0 +1,36 @@ += Issues + +The {mailing list}[mailto:mongrel-unicorn@rubyforge.org] is the best +place to report bugs, submit patches and/or obtain support after you +have searched the mailing list archives and +{documentation}[http://unicorn.bogomips.org]. + +* No subscription is needed to post to the mailing list, + let us know that we need to Cc: replies to you if you're unsubscribed. +* Do not {top post}[http://catb.org/jargon/html/T/top-post.html] in replies +* Quote only the relevant portions of the message you're replying to +* Do not send HTML mail + +If your issue is of a sensitive nature or you're just shy in public, +then feel free to email us privately at mailto:unicorn@bogomips.org +instead and your issue will be handled discreetly. + +If you don't get a response within a few days, we may have forgotten +about it so feel free to ask again. + +== Submitting Patches + +See the HACKING document (and additionally, the +Documentation/SubmittingPatches document distributed with git) on +guidelines for patch submission. + +== Mailing List Info + +* subscribe: http://rubyforge.org/mailman/listinfo/mongrel-unicorn +* post: mailto:mongrel-unicorn@rubyforge.org +* private: mailto:unicorn@bogomips.org + +== Mailing List Archives + +* nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general +* http://rubyforge.org/pipermail/mongrel-unicorn diff --git a/KNOWN_ISSUES b/KNOWN_ISSUES index 979ac9d..83b3584 100644 --- a/KNOWN_ISSUES +++ b/KNOWN_ISSUES @@ -1,5 +1,8 @@ = Known Issues +Occasionally odd {issues}[link:ISSUES.html] arise without a transparent or +acceptable solution. Those issues are documented here. + * Rails 2.3.2 bundles its own version of Rack. This may cause subtle bugs when simultaneously loaded with the system-wide Rack Rubygem which Unicorn depends on. Upgrading to Rails 2.3.4 (or later) is diff --git a/README b/README index 75c6b22..11a9a3c 100644 --- a/README +++ b/README @@ -131,8 +131,8 @@ options. == Disclaimer -There is NO WARRANTY whatsoever if anything goes wrong, but let us know -and we'll try our best to fix it. +There is NO WARRANTY whatsoever if anything goes wrong, but +{let us know}[link:ISSUES.html] and we'll try our best to fix it. Unicorn is designed to only serve fast clients either on the local host or a fast LAN. See the PHILOSOPHY and DESIGN documents for more details @@ -141,13 +141,9 @@ regarding this. == Contact All feedback (bug reports, user/development dicussion, patches, pull -requests) go to the mailing list/newsgroup. Patches must be sent inline -(git format-patch -M + git send-email). No subscription is necessary -to post on the mailing list. No top posting. Address replies +To:+ -the mailing list. - -* email: mailto:mongrel-unicorn@rubyforge.org -* nntp: nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general -* archives: http://rubyforge.org/pipermail/mongrel-unicorn/ -* subscribe: http://rubyforge.org/mailman/listinfo/mongrel-unicorn/ -* finger: unicorn@bogomips.org +requests) go to the mailing list/newsgroup. See the ISSUES document for +information on the {mailing list}[mailto:mongrel-unicorn@rubyforge.org]. + +For the latest on Unicorn releases, you may also finger us at +unicorn@bogomips.org or check our NEWS page (and subscribe to our Atom +feed). -- cgit v1.2.3-24-ge0c7