Re: [mongrel2] Mongrel Manual Draft Is Done, With PDF
- From:
- Zed A. Shaw
- Date:
- 2010-07-30 @ 18:32
On Fri, Jul 30, 2010 at 01:16:10PM +0200, code@archiloque.net wrote:
> > I just finished everything I wanted to write for the Mongrel2 manual and
> > crafted the PDF. Please take a look and let me know what needs fixing.
> > I haven't done much copy editing so it's probably full of mistakes.
> >
> > http://mongrel2.org/doc/tip/docs/manual/book.wiki
> > http://mongrel2.org/static/book-final.pdf
> >
> > The PDF is only 39 pages, and hopefully it reads really well, but any
> > feedback is welcome.
>
>
> - "Edsgers" : I suggest to mention it's Dijkstra as it's the usual way to
> name him
Cool thanks for these. With this one though, I liked the style of
"Edsgers" for some reason.
--
Zed A. Shaw
http://zedshaw.com/
Re: [mongrel2] Mongrel Manual Draft Is Done, With PDF
- From:
- Tordek
- Date:
- 2010-07-30 @ 18:45
On 30/07/10 15:32, Zed A. Shaw wrote:
> On Fri, Jul 30, 2010 at 01:16:10PM +0200, code@archiloque.net wrote:
>> > I just finished everything I wanted to write for the Mongrel2 manual and
>> > crafted the PDF. Please take a look and let me know what needs fixing.
>> > I haven't done much copy editing so it's probably full of mistakes.
>> >
>> > http://mongrel2.org/doc/tip/docs/manual/book.wiki
>> > http://mongrel2.org/static/book-final.pdf
>> >
>> > The PDF is only 39 pages, and hopefully it reads really well, but any
>> > feedback is welcome.
>>
>>
>> - "Edsgers" : I suggest to mention it's Dijkstra as it's the usual way to
>> name him
>
> Cool thanks for these. With this one though, I liked the style of
> "Edsgers" for some reason.
>
I'm trying out my hand at copyediting the manual a bit; I've just
done the introduction. Should I send patches through here, or is
there some protocol involved?
--
Guillermo O. «Tordek» Freschi.
http://tordek.com.ar :: http://twitter.com/tordek
Re: [mongrel2] Mongrel Manual Draft Is Done, With PDF
- From:
- Zed A. Shaw
- Date:
- 2010-07-30 @ 19:14
On Fri, Jul 30, 2010 at 03:45:22PM -0300, Tordek wrote:
> On 30/07/10 15:32, Zed A. Shaw wrote:
> > On Fri, Jul 30, 2010 at 01:16:10PM +0200, code@archiloque.net wrote:
>
> I'm trying out my hand at copyediting the manual a bit; I've just
> done the introduction. Should I send patches through here, or is
> there some protocol involved?
You should put them into fossil as commits, and then we can coordinate
on IRC for me to pull them, or I can show you how to drop a diff from
fossil.
Just do this:
fossil setting autosync 0
And that'll let you do commits "git style" locally without having to
push. I won't be touching the manual, so you'll just need to your work
and then commit and then I can pull later.
Let me know how it works.
--
Zed A. Shaw
http://zedshaw.com/
Re: [mongrel2] Mongrel Manual Draft Is Done, With PDF
- From:
- Simon Williams
- Date:
- 2010-07-30 @ 16:42
- in the preface: "The Edsgers feel that the internet is completely unsafe
and until it is a fully curate and crafted ...", curate -> curated
- in html all footnote links are broken.
- in pdf, footnote links seem to push the actual footnote content just off
the top of the page. So I click on a footnote link, and then have to
scroll up to read it.
- in Note 2, second to last sentence, "f you read that Mongrel2 uses
SQLite and though this was weird...", though -> thought
- in 3.4.4, last sentence, "...to control out Dirs work.", out -> how
- 3.4.6, first paragraph, last sentence, "Most testing has been done with
tcp transports the most.", get rid of that last "the most"
- 3.6, fourth example bullet, "then 1 or long sequence of digits...",
should be 1 or more long
- 3.6 and possibly earlier when you use the r'/images/(.*.jpg)' example,
shouldn't we be escaping the second dot? Which would make it
r'/images/(.*\.jpg)'
- pdf version, Source 10 Example Commit Log, text is getting cut off on
the right side of the page. Same with Source 15
- 4.6 last sentence, "If you do your curl check to fast then you might
miss it so just wait a bit.", to -> too
- 5.2, third to last paragraph, this sentence doesn't make sense to me,
"This means that unlike classic sockets who connects and who binds doesn’t
matter for the direction or kind of message."
- 5.2.1, "Here’s an example that does the sme thing but with REQ/REP style
of messages.", sme -> same
- In html, the source listings look really bad and are hard to read. I
read the intro, and I'm all for Knuth style practicality, but I think in
this case it takes away from the document by making the code references
difficult to read.
Overall looks really great thought. Exciting stuff.
Simon
On Jul 30, 2010, at 5:16 AM, code@archiloque.net wrote:
>> I just finished everything I wanted to write for the Mongrel2 manual and
>> crafted the PDF. Please take a look and let me know what needs fixing.
>> I haven't done much copy editing so it's probably full of mistakes.
>>
>> http://mongrel2.org/doc/tip/docs/manual/book.wiki
>> http://mongrel2.org/static/book-final.pdf
>>
>> The PDF is only 39 pages, and hopefully it reads really well, but any
>> feedback is welcome.
>
> html version:
>
> - the section titles under the sections name is a bit ackward
>
> - "Edsgers" : I suggest to mention it's Dijkstra as it's the usual way to
> name him
>
> - "[^set] Inverse character set, so [" image is missing for the 0
>
> - "What About FastCGI/AJP/CGI/SCGI/WSGI/Rack?": rack support is just
> mentionned above
>
> - "only does MOngrel2 reject bad re" uppercase O
>
> - "I absolutely hate flash" lowercase F
>
> - perhaps mention it's under BSD license somewhere in the preface
>
> At the end: great stuff
>
> /A.
>
Re: [mongrel2] Mongrel Manual Draft Is Done, With PDF
- From:
- Zed A. Shaw
- Date:
- 2010-07-30 @ 18:30
On Fri, Jul 30, 2010 at 10:42:26AM -0600, Simon Williams wrote:
> - in the preface: "The Edsgers feel that the internet is completely
unsafe and until it is a fully curate and crafted ...", curate -> curated
Awesome, thanks!
--
Zed A. Shaw
http://zedshaw.com/