Skip to content

Commit 25d32e8

Browse files
committed
Merge pull request openresty#10 from studdugie/master
Tried to improved flow even more
2 parents f9df911 + e948988 commit 25d32e8

File tree

1 file changed

+44
-41
lines changed

1 file changed

+44
-41
lines changed

en/00-Foreword01.tut

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,52 @@
11
= Foreword =
22

3-
I've been doing a lot of work in the Nginx world over the last few years and
3+
I've been doing a lot of work in the Nginx world over the last few years and
44
I've also been thinking about writing a series of tutorial-like articles to
55
explain to more people what I've done and what I've learned in this area. Now I
6-
have finally decided to post serial tutorials to the Sina Blog
6+
have finally decided to post serial articles to the Sina Blog
77
L<http://blog.sina.com.cn/openresty> in Chinese. Every article will roughly
8-
cover a single topic and will be in a rather casual style. They're not parts of
9-
a book after all. That said, I do have plans to re-organize them to form a real
10-
book.
8+
cover a single topic and will be in a rather casual style. But at some point in
9+
the future I may restructure the articles and their style in order to turn them
10+
into a "real" book.
1111

12-
The tutorials are divided into series. For example, the first series is
12+
The articles are divided into series. For example, the first series is
1313
"Nginx Variables". Each series can be thought of as mapping to a chapter in the
14-
Nginx book that I may publish in the future (of course, I will also reorganize
15-
the content to form "sections"). The tutorials are intended for Nginx users at
16-
various levels, including those Apache and Lighttpd users who may have never
17-
used Nginx before.
18-
19-
The examples in my tutorials are at least compatible with Nginx C<0.8.54>. Do
20-
not try the examples with older versions of Nginx. The latest stable version as
21-
of this writing is C<1.0.10> after all.
22-
23-
All of the Nginx modules mentioned in these tutorials are production-ready. So I
24-
will not be covering any Nginx core modules that are either experimental or
25-
buggy. Additionally, I will be making extensive use of 3rd-party Nginx modules
26-
in my examples. If it's inconvenient for you to download and install the
27-
individual modules one at a time then I highly recommend that you download and
28-
install the C<ngx_openresty> software bundle that I maintain.
14+
Nginx book that I may publish in the future.
15+
16+
The articles are intended for Nginx users of all experience levels, including
17+
users with extensive Apache and Lighttpd experience who may have never used
18+
Nginx before.
19+
20+
The examples in the articles are at least compatible with Nginx C<0.8.54>. Do
21+
not try the examples with older versions of Nginx. The latest stable version of
22+
Nginx as of this writing is C<1.7.9>.
23+
24+
All of the Nginx modules referenced in the articles are production-ready. I will
25+
not be covering any Nginx core modules that are either experimental or buggy.
26+
Additionally, I will be making extensive use of 3rd-party Nginx modules in the
27+
examples. If it's inconvenient for you to download and install the individual
28+
modules one at a time then I highly recommend that you download and install the
29+
C<ngx_openresty> software bundle that I maintain.
2930

3031
L<http://openresty.org/|http://openresty.org/>
3132

32-
All of the modules mentioned in these tutorials, including the core Nginx
33-
modules that are new but stable, are included in the C<openresty> bundle.
33+
All of the modules referenced in the articles, including the core Nginx modules
34+
that are new (but stable), are included in the OpenResty bundle.
3435

35-
One principle that I've been trying to follow in these tutorials is to use small
36-
and concise configuration examples to explain and validate the concepts and
37-
principles being described. I hope this will help the reader to develop the good
38-
habit of not accepting others' viewpoints or statements at face value without
39-
testing them first. This style may have something to do with my QA background.
40-
In fact, I keep adjusting and correcting the tutorial based on the results of
41-
running the examples while writing.
36+
A principle that I will be trying to adhere to is to use small concise examples
37+
to explain and validate the concepts and behaviors being described. My hope is
38+
that it will help the reader to develop the good habit of not accepting others'
39+
viewpoints or statements at face value without testing them first. This approach
40+
may have something to do with my QA background. In fact, I keep tweaking and
41+
correcting the articles based on the results of running the examples while
42+
writing.
4243

43-
For problematic code samples, I will intentionally make them look different from
44-
the good samples, that is, all the lines of the bad samples will be prefixed
45-
with a question mark, i.e., "C<?>". Here is an example:
44+
The examples in the articles fall into one of two categories, good and
45+
problematic. The purpose of the problematic examples is to highlight potential
46+
pitfalls and other areas where Nginx or its modules behave in ways that readers
47+
may not expect. Problematic examples are easy to identify because each line of
48+
text in the example will be prefixed with a question mark, i.e., "C<?>". Here is
49+
an example:
4650

4751
:nginx
4852
? server {
@@ -59,23 +63,22 @@ reserved.
5963
I encourage readers to send feedback (C<[email protected]>), especially
6064
constructive criticism.
6165

62-
The source for all the articles is on GitHub and is under version control:
66+
The source for all the articles is on GitHub:
6367

6468
L<http://github.com/agentzh/nginx-tutorials/>
6569

6670
The source files are under the F<en/> directory. I am using a little markup
67-
language that is a mixture of C<Wiki> and C<POD> to write these articles.
68-
They are the F<.tut> files. You are very welcome to create forks and/or provide
69-
patches.
71+
language that is a mixture of C<Wiki> and C<POD> to write these articles. They
72+
are the F<.tut> files. You are welcome to create forks and/or provide patches.
7073

71-
The e-books files that are suitable for cellphones, Kindle,
72-
iPad/iPhone, Sony Readers, and other devices, can be downloaded from here:
74+
The e-books files that are suitable for cellphones, Kindle, iPad/iPhone,
75+
Sony Readers, and other devices can be downloaded from here:
7376

7477
L<http://openresty.org/#eBooks>
7578

76-
Special thanks go to Kai Wu (kai10k) who kindly translates these tutorials to English.
79+
Special thanks go to Kai Wu (kai10k) who kindly translates these articles to
80+
English.
7781

7882
agentzh at home in the Fuzhou city
7983

8084
October 30, 2011
81-

0 commit comments

Comments
 (0)