Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 71 lines (38 sloc) 2.824 kb
9fedf3f converting markdown to html
Noah Slater authored
1 <h1>CouchDB: The Definitive Guide</h1>
e2c4f69 import of work in progress website
Noah Slater authored
2
f71c50e edits for README.md
Noah Slater authored
3 <p>This is the source for the book’s website.
e2c4f69 import of work in progress website
Noah Slater authored
4
9fedf3f converting markdown to html
Noah Slater authored
5 <h2>Organisation</h2>
e2c4f69 import of work in progress website
Noah Slater authored
6
bd74185 edits for README.md
Noah Slater authored
7 <p>The source is organised into the following directories:
8
ea71c59 edits for README.md
Noah Slater authored
9 <dl>
e2c4f69 import of work in progress website
Noah Slater authored
10
ea71c59 edits for README.md
Noah Slater authored
11 <dt><code>draft/</code></dt>
e2c4f69 import of work in progress website
Noah Slater authored
12
a1b986d edits for README.md
Noah Slater authored
13 <dd><p>The draft of next edition.</dd>
ea71c59 edits for README.md
Noah Slater authored
14
15 <dt><code>editions/</code></dt>
16
a1b986d edits for README.md
Noah Slater authored
17 <dd><p>Published editions of the book.</dd>
1a7223b edits for README.md
Noah Slater authored
18
19 <dt><code>editions/1</code></dt>
20
21 <dd><p>Edition 1 of the book.</dd>
ea71c59 edits for README.md
Noah Slater authored
22
23 <dt><code>editions/1/en</code></dt>
24
1a7223b edits for README.md
Noah Slater authored
25 <dd><p>The English version of edition 1 of the book.</dd>
ea71c59 edits for README.md
Noah Slater authored
26
27 </dl>
e2c4f69 import of work in progress website
Noah Slater authored
28
13bf5b4 edits for README.md
Noah Slater authored
29 <p>The draft of the next edition is a work in progress. Like the trunk of an open source project, we will eventually cut from this and hand it over to our publishers. Once the publishing process is complete, we will take back the XML and convert it into HTML. Like a tag of an open source project, this will be frozen in place as an official edition of the book. Translations are subject to change and may be updated at any time.
bd74185 edits for README.md
Noah Slater authored
30
9fedf3f converting markdown to html
Noah Slater authored
31 <h2>Contributions</h2>
e2c4f69 import of work in progress website
Noah Slater authored
32
c63d72b edits for README.md
Noah Slater authored
33 <p>The book is made available under a <a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution</a> license.
6a466e4 edits for README.md
Noah Slater authored
34
35 <p>We encourage you to fork our work and make your own improvements under the terms of the license. If you have any changes you want to send back our way, please make a regular pull request via Github. If the authors like your changes, we may integrate them into the official book and give you a credit in the next edition. If you just have an issue to report, please use the regular Github issue system.
e2c4f69 import of work in progress website
Noah Slater authored
36
9fedf3f converting markdown to html
Noah Slater authored
37 <h2>Translations</h2>
e2c4f69 import of work in progress website
Noah Slater authored
38
1da4d31 edits for README.md
Noah Slater authored
39 <p>We’d like to encourage people to start translating the book into other languages. If you’d like to start a new translation, please first check to see if one exists in that language. If not, you can get started right away. You’re free to publish a translation under the aforementioned license. Our publishers may be interested in your translation if you think the market would be big enough. Please contact us directly to discuss this.
40
41 <p>Please observe the following guidelines:
42
43 <ul>
44
1e6783f edits for README.md
Noah Slater authored
45 <li><p>Do start your translation from the <code>en/</code> directory</li>
1da4d31 edits for README.md
Noah Slater authored
46
4a80d4f edits for README.md
Noah Slater authored
47 <li><p>Do use the appropriate <a href="http://en.wikipedia.org/wiki/IETF_language_tag">language tag</a> for your new directory</li>
48
c5cd027 edits for README.md
Noah Slater authored
49 <li><p>Do not translate the <code>draft/</code> directory, as this is will be a work in progress</li>
1da4d31 edits for README.md
Noah Slater authored
50
1e6783f edits for README.md
Noah Slater authored
51 <li><p>Do not translate from anything other than the <code>en/</code> directory, as this will introduce errors</li>
1da4d31 edits for README.md
Noah Slater authored
52
8065b4b edits for README.md
Noah Slater authored
53 <li><p>Do not modify the general markup or structure of the documents</li>
54
55 <li><p>Do not include your own styles or scripts</li>
56
1da4d31 edits for README.md
Noah Slater authored
57 </ul>
e2c4f69 import of work in progress website
Noah Slater authored
58
0fad72c edits for README.md
Noah Slater authored
59 <p>Here’s how you might start a new German translation:
07f4122 edits for README.md
Noah Slater authored
60
61 <pre>
62 cd editions/1
63 cp -r en de
64 git add de
65 git commit -m 'Start German translation' de
66 </pre>
e2c4f69 import of work in progress website
Noah Slater authored
67
0fad72c edits for README.md
Noah Slater authored
68 <p>All you need to do now is work through the chapters and send pull requests.
e2c4f69 import of work in progress website
Noah Slater authored
69
0fad72c edits for README.md
Noah Slater authored
70 <p>Relax.
Something went wrong with that request. Please try again.