Skip to content

Commit a481b0b

Browse files
committed
Fixed a few spelling errors and made a few "stylistics" changes
in an attempt to improve the "flow" for native English speakers.
1 parent 3bf4cc4 commit a481b0b

File tree

1 file changed

+45
-52
lines changed

1 file changed

+45
-52
lines changed

en/00-Foreword01.tut

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

3-
I've been doing a lot of work in the Nginx world over the last few years
4-
and I've also been thinking about writing series of tutorial-like articles
5-
to
6-
explain to more people what I've done and what I've learned in
7-
this area. Now I have finally decided to post serial tutorials to the
8-
Sina Blog L<http://blog.sina.com.cn/openresty> in Chinese. Every article
9-
will have one rough topic and will be in a rather casual style. They're
10-
not parts of a book after all. But I do have plans to re-orginaize these
11-
stuffs to form a real book.
12-
13-
Now the tutorials being written is devided into "series". For example,
14-
the first series is "Nginx Variables". Each series can be roughly mapped
15-
to a chapter in the Nginx book that I may publish in the future (of course,
16-
I will also reorganize the contents to form "sections"). The tutorials
17-
are
18-
intended for Nginx users at various levels, including those Apache and
19-
Lighttpd
20-
users who have never used Nginx before.
21-
22-
The samples in my tutorials are at least compatible with Nginx C<0.8.54>;
23-
do not try the samples with older versions of Nginx. The latest stable
24-
version as of this writing is C<1.0.10> after all.
25-
26-
All of the Nginx modules mentioned in these tutorials are production-ready.
27-
I will not even mention those standard Nginx modules that are either experimental
28-
or buggy.
29-
30-
I'm going to make extensive use of Nginx 3rd-party modules here. If you'
31-
re too
32-
lazy to download and install those modules one by one, then you are recommended
33-
to download and install the C<ngx_openresty> software bundle that is maintained
34-
by me.
3+
I've been doing a lot of work in the Nginx world over the last few years and
4+
I've also been thinking about writing a series of tutorial-like articles to
5+
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
7+
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.
11+
12+
The tutorials are divided into series. For example, the first series is
13+
"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.
3529

3630
L<http://openresty.org/|http://openresty.org/>
3731

38-
All of the modules mentioned in these tutorials, including the Nginx stable
39-
core that is fresh enough, have been included in this bundle.
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.
4034

41-
One principle that I've been trying to follow in these tutorials is to
42-
use small and concise configure examples to validate the concepts and principles
43-
that are being explained. I hope this can help the reader to build the
44-
good habit of not accepting others' viewpoints or statements without testing
45-
them. This style may have something to do with my QA background. In fact,
46-
I keep adjusting and correcting my words according to the running results
47-
of my little samples in the process of writing.
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.
4842

49-
For problematic code samples, we will intentionally make them look different
50-
from those good samples, that is, all the lines of bad samples will
51-
be prefixed with a question mark, i.e., "C<?>". Here is an example:
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:
5246

5347
:nginx
5448
? server {
@@ -62,18 +56,17 @@ be prefixed with a question mark, i.e., "C<?>". Here is an example:
6256
Do not reproduce these articles without explicit permissions from us. Copyright
6357
reserved.
6458

65-
I welcome the readers to send feedback to me (C<[email protected]>), especially constructive criticisms.
59+
I encourage readers to send feedback (C<[email protected]>), especially
60+
constructive criticisms.
6661

67-
The source for all the articles has been put onto the GitHub web site
68-
and is under version control:
62+
The source for all the articles is on GitHub and is under version control:
6963

7064
L<http://github.com/agentzh/nginx-tutorials/>
7165

72-
The source files are under the F<en-uk/> directory. I am using a little
73-
markup language that is a mixture of C<Wiki> and C<POD> to write these
74-
articles.
75-
They are just those F<.tut> files. You are very welcome to create forks
76-
and/or provide patches.
66+
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.
7770

7871
The e-books files that are suitable for cellphones, Kindle,
7972
iPad/iPhone, Sony Readers, and other devices, can be downloaded from here:

0 commit comments

Comments
 (0)