Skip to content
Newer
Older
100644 75 lines (40 sloc) 3.38 KB
9fedf3f converting markdown to html
Noah Slater authored Aug 19, 2010
1 <h1>CouchDB: The Definitive Guide</h1>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
2
7dadc65 edits for README.md
Noah Slater authored Aug 19, 2010
3 <p>This is the source code repository for a free book about Apache CouchDB.
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
4
0bb8728 small edits
Noah Slater authored Aug 19, 2010
5 <h2>Introduction</h2>
6
7 <p>The book is called <em>CouchDB: The Definitive Guide</em> and is published by O’Reilly Media under a <a href="http://creativecommons.org/licenses/by/3.0/">free license</a>.
8
9 <p>We believe that community software needs community documentation. You can inspect the source code for CouchDB and make improvements to it, and similarly you can inspect the source code for this book and make improvements to it. If you want to contribute, please do so! Fork it, hack on it, and send back your changes! If you want to support the project, you can do so by <a href="http://oreilly.com/catalog/9780596155902">buying a copy</a> of the book in digital or printed form.
10
9fedf3f converting markdown to html
Noah Slater authored Aug 19, 2010
11 <h2>Organisation</h2>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
12
bd74185 edits for README.md
Noah Slater authored Aug 19, 2010
13 <p>The source is organised into the following directories:
14
ea71c59 edits for README.md
Noah Slater authored Aug 19, 2010
15 <dl>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
16
ea71c59 edits for README.md
Noah Slater authored Aug 19, 2010
17 <dt><code>draft/</code></dt>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
18
a1b986d edits for README.md
Noah Slater authored Aug 19, 2010
19 <dd><p>The draft of next edition.</dd>
ea71c59 edits for README.md
Noah Slater authored Aug 19, 2010
20
21 <dt><code>editions/</code></dt>
22
a1b986d edits for README.md
Noah Slater authored Aug 19, 2010
23 <dd><p>Published editions of the book.</dd>
1a7223b edits for README.md
Noah Slater authored Aug 19, 2010
24
25 <dt><code>editions/1</code></dt>
26
27 <dd><p>Edition 1 of the book.</dd>
ea71c59 edits for README.md
Noah Slater authored Aug 19, 2010
28
29 <dt><code>editions/1/en</code></dt>
30
1a7223b edits for README.md
Noah Slater authored Aug 19, 2010
31 <dd><p>The English version of edition 1 of the book.</dd>
ea71c59 edits for README.md
Noah Slater authored Aug 19, 2010
32
33 </dl>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
34
13bf5b4 edits for README.md
Noah Slater authored Aug 19, 2010
35 <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 Aug 19, 2010
36
9fedf3f converting markdown to html
Noah Slater authored Aug 19, 2010
37 <h2>Contributions</h2>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
38
c63d72b edits for README.md
Noah Slater authored Aug 19, 2010
39 <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 Aug 19, 2010
40
00ad666 edits for README.md
Noah Slater authored Aug 19, 2010
41 <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, they 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 Aug 6, 2010
42
9fedf3f converting markdown to html
Noah Slater authored Aug 19, 2010
43 <h2>Translations</h2>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
44
1da4d31 edits for README.md
Noah Slater authored Aug 19, 2010
45 <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.
46
47 <p>Please observe the following guidelines:
48
49 <ul>
50
1e6783f edits for README.md
Noah Slater authored Aug 19, 2010
51 <li><p>Do start your translation from the <code>en/</code> directory</li>
1da4d31 edits for README.md
Noah Slater authored Aug 19, 2010
52
4a80d4f edits for README.md
Noah Slater authored Aug 19, 2010
53 <li><p>Do use the appropriate <a href="http://en.wikipedia.org/wiki/IETF_language_tag">language tag</a> for your new directory</li>
54
c5cd027 edits for README.md
Noah Slater authored Aug 19, 2010
55 <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 Aug 19, 2010
56
1e6783f edits for README.md
Noah Slater authored Aug 19, 2010
57 <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 Aug 19, 2010
58
8065b4b edits for README.md
Noah Slater authored Aug 19, 2010
59 <li><p>Do not modify the general markup or structure of the documents</li>
60
61 <li><p>Do not include your own styles or scripts</li>
62
1da4d31 edits for README.md
Noah Slater authored Aug 19, 2010
63 </ul>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
64
0b8aff6 edits for README.md
Noah Slater authored Aug 19, 2010
65 <p>Here’s an example of how to start a new translation:
07f4122 edits for README.md
Noah Slater authored Aug 19, 2010
66
67 <pre>
68 cd editions/1
69 cp -r en de
70 git add de
0b8aff6 edits for README.md
Noah Slater authored Aug 19, 2010
71 git commit -m 'new German translation' de
07f4122 edits for README.md
Noah Slater authored Aug 19, 2010
72 </pre>
e2c4f69 import of work in progress website
Noah Slater authored Aug 6, 2010
73
0fad72c edits for README.md
Noah Slater authored Aug 19, 2010
74 <p>Relax.
Something went wrong with that request. Please try again.