Merge pull request #1 from GitbookIO/some-inputs

SamyPesse · SamyPesse · commit 9ab64d7e94a7 · 2016-04-27T11:16:48.000+02:00
Some initial inputs
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -8,7 +8,6 @@
 * [Does GitBook own any rights on my book?](basics/does-gitbook-own-any-rights.md)
 * [Can I run GitBook on-premise (on my own servers)?](basics/can-i-run-gitbook-on-premise.md)
 * [Who's using GitBook?](basics/who-s-using-gitbook.md)
-* [Do you offer education discounts?](basics/do-you-offer-discounts.md)
 
 ### Accounts & Billing
 
@@ -17,6 +16,8 @@
 * [How do I delete my user account?](accounts/how-do-i-delete-account.md)
 * [Will there be a minimum contract with premium plans?](accounts/will-there-be-a-minimal-contract.md)
 * [Are the plans' prices the same worldwide?](accounts/are-prices-same-worldwide.md)
+* [Are the plans's prices the same worldwide?](accounts/are-prices-same-worldwide.md)
+* [Do you offer education discounts?](accounts/do-you-offer-discounts.md)
 * [What payment methods do you accept?](accounts/what-payment-methods-do-you-accept.md)
 * [Why am I getting an error "An account with this email address already exists"?](accounts/why-error-duplicate.md)
 
@@ -53,7 +54,7 @@
 * [How can I create an organization?](orgs/how-can-i-create.md)
 * [How can I convert an user into an organization?](orgs/how-can-i-convert-user.md)
 * [How can I transfer the organization ownership?](orgs/how-can-i-transfer-ownership.md)
-* [How do I delete an organization account?](orgs/how-do-i-delete.md)
+* [How do I delete an organization account?](orgs/how-do-i-delete-organization.md)
 
 ### Editor
 
diff --git a/accounts/are-prices-same-worldwide.md b/accounts/are-prices-same-worldwide.md
@@ -1 +1 @@
-Yes, Charges to your account will be made in US Dollars. Local prices will change as the exchange rate fluctuates.
+The plan's prices are the same worldwide. Charges to your account will be made in US dollars. Local prices will change as the exchange rate fluctuates.
diff --git a/accounts/do-you-offer-discounts.md b/accounts/do-you-offer-discounts.md
@@ -0,0 +1,6 @@
+---
+search_keywords: ["promo", "discount", "student", "teacher", "school", "non-profit"]
+
+---
+
+Yes, we offer discounted plans to students, teachers, schools and open source projects. [Contact us](https://www.gitbook.com/contact).
diff --git a/accounts/how-do-i-delete-account.md b/accounts/how-do-i-delete-account.md
@@ -1,11 +1,11 @@
 ---
 related:
     - orgs/how-can-i-transfer-ownership.md
-    - orgs/how-do-i-delete.md
+    - orgs/how-do-i-delete-organization.md
 ---
 
-You can [delete your GitBook user account](https://www.gitbook.com/settings/delete) at any time. Before you do so, you must hand over the reins of any organizations you might own and delete or transfer ownership of all your existing books.
+You can [delete your GitBook user account](https://www.gitbook.com/settings/delete) at any time. Be careful, this operation **CANNOT** be undone.
 
-This action **CANNOT** be undone. Discussions you've created and comments you've made in books owned by other users will not be deleted - instead, they'll be associated with a Ghost user.
+Before you do so, you should transfer ownership of any organizations you might own. All books owned by your account will be lost, so you might want to transfer them to another user too. However, discussions and comments you have made in other people's books will remain, becoming anonymous (with Ghost user as author).
 
-The account name also becomes available to anyone else to use on a new account, and we stop billing you.
+Your account name will become available to anyone else to create a new account, and we will stop billing you.
diff --git a/accounts/why-error-duplicate.md b/accounts/why-error-duplicate.md
@@ -1,7 +1,14 @@
-If you're getting an error:
+---
+search_keywords: ["duplicate"]
 
-```
-An account with this email address already exists
-```
+---
 
-// tofinish
+If you're getting an error such as `An account with this email address already exists`, it means that you have created two distinct accounts. This happens if you register with a Social Account (Facebook, Twitter, GitHub or Google), then register again using the form.
+
+In this case, you need to **remove** one of these account, to do so:
+
+1. Log out from the account associated with your email
+2. Log in using the social account instead
+3. Delete this account at [www.gitbook.com/settings](https://www.gitbook.com/settings)
+4. Log in again using your email
+5. Associate the Social Account to your email account at [www.gitbook.com/settings](https://www.gitbook.com/settings)
diff --git a/basics/can-i-run-gitbook-on-premise.md b/basics/can-i-run-gitbook-on-premise.md
@@ -1,3 +1,3 @@
-We can supply an on-premise version of GitBook for large enterprises with security concerns.
+We supply an on-premise version of GitBook for large enterprises with security concerns.
 
 [Contact us](https://enterprise.gitbook.com) to get more details about our on-premise version.
diff --git a/basics/do-you-offer-discounts.md b/basics/do-you-offer-discounts.md
diff --git a/basics/does-gitbook-own-any-rights.md b/basics/does-gitbook-own-any-rights.md
@@ -1,4 +1,3 @@
-We don't reserve any rights on the content you produce, you are the sole rights-owner of your book.
-
-You can sell your book on Amazon, iBooks Store or send it to a publisher.
+We don't reserve any right on the content you produce, you are the sole right owner of your book.
 
+You are free to sell your book on Amazon, iBooks Store or send it to a publisher.
diff --git a/basics/for-faq-documentation.md b/basics/for-faq-documentation.md
@@ -1,3 +1,3 @@
-Yes, As a matter of fact this Help Center is hosted on GitBook.com.
+Yes, as a matter of fact this Help Center is made with [GitBook](https://github.com/GitbookIO/gitbook) and hosted on [GitBook.com](https://gitbook.com).
 
 GitBook is perfectly suited for publishing an F.A.Q. You can get started by creating a Book with the "Help Center" template.
diff --git a/basics/what-is-gitbook.md b/basics/what-is-gitbook.md
@@ -3,6 +3,6 @@ related:
     - basics/who-s-using-gitbook.md
 ---
 
-GitBook is both an online platform for writing and hosting documentation, and an open source [book format](https://github.com/GitbookIO/gitbook).
+GitBook is both an [online platform](https://gitbook.com) for writing and hosting documentation, and an open source [book format](https://github.com/GitbookIO/gitbook).
 
-GitBook is being used by more than 150,000 authors to publish documentation (API Documentation, Knowledge Base, etc).
+More than 100,000 authors use GitBook, mainly to publish documentations (library, API, tools, etc.), or knowledge bases (like this F.A.Q.). People also use GitBook to publish technical books, teaching material, and many other things.
diff --git a/basics/who-s-using-gitbook.md b/basics/who-s-using-gitbook.md
@@ -1,5 +1,4 @@
-GitBook is being used by more than 100,000 authors, developers, teachers, etc to publish content.
+GitBook is being used by more than 100,000 authors, developers, teachers, and students to publish content.
 
-GitBook is also being used by companies like:
+GitBook is also being used by companies ([DuckDuckGo](http://docs.duckduckhack.com)), by organizations ([Django Girls](http://tutorial.djangogirls.org/)), and for open-source projects ([Redux](http://redux.js.org/)).
 
-- [DuckDuckGo](http://docs.duckduckhack.com)
diff --git a/books/can-i-use-custom-domain.md b/books/can-i-use-custom-domain.md
@@ -1,6 +1,6 @@
 All books on **Gitbook.com** are served under `http://{author}.gitbooks.io/{book}/`, the book's content is available at `http://{author}.gitbooks.io/{book}/content/`.
 
-But you can configure your book to use a custom domain name (a free feature on GitBook). Domain names can be used for your homepage or content (or both).
+But you can configure your book to use a custom domain name (a free feature of GitBook.com). Domain names can be used for your homepage, your content, or both.
 
 Adding a custom domain is easy.
 
@@ -16,6 +16,6 @@ To finish the setup you will need to make a few changes with your domain registr
 
 2. Set the `www` record to a **CNAME** and set the URL field to: ```www.gitbooks.io```.
 
-3. To **redirect** the naked domain (`yourdomain.com`) to `www.yourdomain.com`, you'll need to enable *"domain forwarding"*. This is often found under 'Forwarding', 'URL Forwarding' or 'URL Redirect'.
+3. To **redirect** the naked domain (`yourdomain.com`) to `www.yourdomain.com`, you'll need to enable *"domain forwarding"*. This is often found under `Forwarding`, `URL Forwarding` or `URL Redirect`.
 
 That's all ! It might take a few hours for the DNS to propagate.
diff --git a/books/how-can-i-disable-access-key.md b/books/how-can-i-disable-access-key.md
@@ -1,3 +1,3 @@
-If you unintentionally shared an Access Key with the wrong person or want to temporarily disable this feature:
+Sometimes, you need to temporarily disable or revoke an Access Key. For example when you unintentionally shared an Access Key with the wrong person.
 
-From the **Access Keys dashboard** (located in your book settings on GitBook.com), you can **disable** an Access Key to temporary revoke a read-access or **delete** it.
+In the book settings on GitBook.com, from the **Access Keys dashboard**, you can **disable** an Access Key to temporary revoke a read-access, or you can **delete** it.
diff --git a/books/how-can-i-grant-read-access.md b/books/how-can-i-grant-read-access.md
@@ -4,8 +4,5 @@ related:
     - books/what-is-an-access-key.md
 ---
 
-You can grant read-only access to a private books using two methods:
-
-- **Invite as collaborator**
-- **Create an Access Key**
+There are two ways to grant read-only access to a private book: by **inviting him as Collaborator**, or by **creating an Access Key**.
 
diff --git a/books/how-many-books.md b/books/how-many-books.md
diff --git a/books/import-word-pdf-document.md b/books/import-word-pdf-document.md
@@ -0,0 +1,60 @@
+<!-- TODO simplify ? The article is already laid out so the important info comes first -->
+
+Importing an existing document to GitBook is easy. Upload it when creating a book using the _Import_ tab.
+
+##### Accepted formats
+
+Here are the formats available for importation:
+
+| Type | Extension |
+| ---- | --------- |
+| Microsoft Word Document | `.docx` |
+| DocBook v5.x | `.xml` |
+| HTML file | `.html` |
+
+For better results, we recommend using:
+* Microsoft Word 2007+ documents
+* DocBook v5.x documents
+
+For DocBook v4 documents, consider [converting them automatically to version 5](http://doccookbook.sourceforge.net/html/en/dbc.structure.db4-to-db5.html) for improved compatibility.
+
+##### Conversion
+
+This conversion generates a set of markdown files from the original document, along with a suitable `SUMMARY.md`.
+
+For example, a document with this structure...
+
+    [Content here becomes the book's README.md]
+
+    * Section 1
+        [Content here becomes the a chapter's README.md]
+        * Section 1.1
+            * Section 1.1.1
+            * Section 1.1.2
+
+        * Section 1.2
+
+    * Section 2
+        [Content here becomes the content of chapter 2]
+
+... will be converted to a book with this structure:
+
+    .
+    ├── README.md
+    ├── SUMMARY.md
+    ├── section-1
+    │   ├── README.md
+    │   ├── section-1-1.md
+    │   └── section-1-2.md
+    └── section-2.md
+
+
+Also, for `.docx` documents, all included images are exported to an `assets/` folder.
+
+#### Command line
+
+The import feature uses the [gitbook-convert](https://github.com/GitbookIO/gitbook-convert) CLI utility. If you ever need more flexibility, consider using [gitbook-convert](https://github.com/GitbookIO/gitbook-convert) locally, create a repository and import it using Git or GitHub.
+
+[gitbook-convert](https://github.com/GitbookIO/gitbook-convert) infers a book structure from your document's structure, based on header levels. Top-level headers become chapters. Chapters are folders with a `README.md` as preface, and sub-chapters for every second-level headers. If no second-level headers are present, the chapter will consist of a single file instead of a folder.
+
+
diff --git a/books/who-can-edit-book.md b/books/who-can-edit-book.md
@@ -3,9 +3,10 @@ related:
     - books/what-is-a-collaborator.md
 ---
 
-Only the owner and collaborators can edit a book (public or private).
+Only the owner and collaborators can edit a book (be it public or private).
 
 If the book is owned by an organization, the organization's permissions are applied to all its books.
 
-In the case of a member specified as a collaborator of a book with a different set of permissions, **the book's permissions overwrite the organization's**.
+**The book's permissions overwrite the organization's**. To control a member's access at a book level, you can add him or her as collaborator of the book and specify a different set of permissions.
+
 
diff --git a/books/who-can-read-book.md b/books/who-can-read-book.md
@@ -4,8 +4,8 @@ related:
     - books/what-is-an-access-key.md
 ---
 
-**If the book is public**, Anyone can read and download the book.
+**If the book is public**, anyone can read and download the book.
 
-**If the book is private**, Only collaborators or people with access keys can read the book.
+**If the book is private**, only collaborators or people with access keys can read the book.
 
 
diff --git a/content/can-i-customize-design.md b/content/can-i-customize-design.md
@@ -2,10 +2,12 @@
 related:
     - content/how-can-i-include-css.md
     - content/how-can-i-change-theme.md
+    - content/how-can-i-add-plugin.md
+
 ---
 
-Yes, Almost everything in GitBook can be customized:
+Yes, almost everything in GitBook can be customized:
 
 - [You can include custom CSS](how-can-i-include-css.md)
 - [You can change the whole theme](how-can-i-change-theme.md)
-
+- [You can use plugins](how-can-i-add-plugin.md)
diff --git a/content/how-can-i-add-plugin.md b/content/how-can-i-add-plugin.md
@@ -1,4 +1,9 @@
-Plugins are the more efficient way to include dynamic content or change the default behavior of GitBook.
+---
+search_keywords: ["install", "plugin"]
+
+---
+
+[Plugins](https://plugins.gitbook.com) are the most efficient way to include dynamic content or change the default behavior of GitBook.
 
 ### From the editor
 
diff --git a/content/how-can-i-change-theme.md b/content/how-can-i-change-theme.md
@@ -4,3 +4,5 @@ Since GitBook v3, the whole theme can be changed.
 ### Examples of themes
 
 - [faq](https://github.com/GitbookIO/theme-faq): create a knowledge base using GitBook
+
+<!-- TODO add more examples -->
diff --git a/content/how-can-i-include-css.md b/content/how-can-i-include-css.md
@@ -1,7 +1,7 @@
 You can specify CSS files to be included in your book's website or PDF by creating files:
 
-- **styles/website.css**: It will apply only to the website
-- **styles/pdf.css**: It will apply only to the PDF
-- **styles/ebook.css**: It will apply to all ebook formats (PDF, Mobi, ePub)
+- **styles/website.css**: will apply only to the website
+- **styles/pdf.css**: will apply only to the PDF
+- **styles/ebook.css**: will apply only to ebook formats (PDF, Mobi, ePub)
 
-Some plugins exist to make it possible to use [Less](https://plugins.gitbook.com/plugin/styles-less) or [Sass](https://plugins.gitbook.com/plugin/styles-sass).
+Plugins exist to allow using [Less](https://plugins.gitbook.com/plugin/styles-less) or [Sass](https://plugins.gitbook.com/plugin/styles-sass).
diff --git a/content/how-can-i-include-dynamic.md b/content/how-can-i-include-dynamic.md
@@ -3,4 +3,4 @@ related:
     - content/how-can-i-add-plugin.md
 ---
 
-GitBook is very entensible, and dynamic content such as [Youtube video](https://plugins.gitbook.com/plugin/youtube) or [Gist](https://plugins.gitbook.com/plugin/gist) can be embed in your book using [Plugins](https://plugins.gitbook.com).
+GitBook is very entensible, and dynamic content such as [Youtube videos](https://plugins.gitbook.com/plugin/youtube) or [Gists](https://plugins.gitbook.com/plugin/gist) can be embedded in your book using [Plugins](https://plugins.gitbook.com).
diff --git a/editor/can-i-edit-offline.md b/editor/can-i-edit-offline.md
@@ -3,6 +3,4 @@ related:
     - editor/what-os-are-supported.md
 ---
 
-Yes, [GitBook Editor](https://www.gitbook.com/editor) is released as a desktop application for Windows, Mac OS X and Linux.
-
-It lets you edit your book on your desktop and sync your modifications online once you're ready.
+The [GitBook Editor](https://www.gitbook.com/editor) is released as a desktop application for Windows, Mac OS X and Linux, and supports offline editing. You can always synchronize your modifications once you are back online, or when you feel ready.
diff --git a/github/can-i-host-on-github.md b/github/can-i-host-on-github.md
@@ -1,3 +1,5 @@
+<!-- TODO Reuse the article from documentation/doc-separation and make a it _guide_ -->
+
 GitBook integrates perfectly with [GitHub](https://github.com) as a hosting solution for the source of your book. When configured correctly, this has several effects:
 
 - The Editor will make changes directly to the GitHub repository
diff --git a/github/how-can-i-export-to-repo.md b/github/how-can-i-export-to-repo.md
@@ -1,3 +1,5 @@
+<!-- TODO Link to guide for GitHub hosting -->
+
 If you started writing your book on GitBook and you now want to [host its source on GitHub](can-i-host-on-github.md), don't worry, it's easy. To do so, you can either use the GitHub import tool, or operate from the command line.
 
 #### Using the GitHub Import Tool
diff --git a/orgs/how-can-i-transfer-ownership.md b/orgs/how-can-i-transfer-ownership.md
@@ -6,7 +6,7 @@ To make someone else the owner of an organization account, you must add a new ow
 
 2. Contact the new owner and make sure he or she is able to access the organization's settings.
 
-3. If you are currently responsible for paying for GitBook in your organization, you'll also need to change the organization's billing information to reflect the new owner.
+3. If needed, update the organization's billing information to reflect the new owner.
 
 4. Remove yourself from the organization.
 
diff --git a/orgs/how-do-i-delete-organization.md b/orgs/how-do-i-delete-organization.md
diff --git a/orgs/what-is-an-organization.md b/orgs/what-is-an-organization.md
@@ -1,9 +1,16 @@
+---
+related:
+    - what-is-difference.md
+    - how-can-i-create.md
+
+---
+
 Organizations are a special type of accounts with multiple team members.
 
 Organizations are great for businesses and large projects that need multiple owners and admins. They include:
 
 * Business plans for private books and distribution
-* Collaborators-based access permissions
+* Collaborator-based access permissions
 * Unlimited administrators and collaborators using teams
 * Billing receipts that can be sent to a secondary email address
 
diff --git a/orgs/what-is-difference.md b/orgs/what-is-difference.md
@@ -1 +1 @@
-Your user account is your identity on GitBook. Your user account can be a member of any number of organizations, regardless of whether the account is on a free or paid plan.
+Your user account is your identity on GitBook. Your user account can be a member of any number of organizations, whether you are on a free or paid plan.

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-Yes, Charges to your account will be made in US Dollars. Local prices will change as the exchange rate fluctuates.`
	`1`	`+The plan's prices are the same worldwide. Charges to your account will be made in US dollars. Local prices will change as the exchange rate fluctuates.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +---
 +search_keywords: ["promo", "discount", "student", "teacher", "school", "non-profit"]
++
 +---
++
 +Yes, we offer discounted plans to students, teachers, schools and open source projects. [Contact us](https://www.gitbook.com/contact).
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-We can supply an on-premise version of GitBook for large enterprises with security concerns.`
	`1`	`+We supply an on-premise version of GitBook for large enterprises with security concerns.`
`2`	`2`
`3`	`3`	`[Contact us](https://enterprise.gitbook.com) to get more details about our on-premise version.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-Yes, As a matter of fact this Help Center is hosted on GitBook.com.`
	`1`	`+Yes, as a matter of fact this Help Center is made with [GitBook](https://github.com/GitbookIO/gitbook) and hosted on [GitBook.com](https://gitbook.com).`
`2`	`2`
`3`	`3`	`GitBook is perfectly suited for publishing an F.A.Q. You can get started by creating a Book with the "Help Center" template.`