Merge pull request #409 from louisguitton/docs-cleanup

Cleanup mkdocs website

docs/faq.md

@@ -3,36 +3,36 @@
 Following list is ordered by from easy to hard. If you are not familiar with Python development, please consider easy setup.
 
 1. [One click deployment to Cloud Service.](https://github.com/chakki-works/doccano#deployment)
-   * Only you have to do is create an account. Especially [Heroku](https://www.heroku.com/home) does not require your credit card (if free plan).
-   * [![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fchakki-works%2Fdoccano%2Fmaster%2Fazuredeploy.json)
-   * [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
-   * [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano)
-   * > Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/chakki-works/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).
+    * Only you have to do is create an account. Especially [Heroku](https://www.heroku.com/home) does not require your credit card (if free plan).
+    * [![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fchakki-works%2Fdoccano%2Fmaster%2Fazuredeploy.json)
+    * [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
+    * [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-external-1.amazonaws.com/cf-templates-10vry9l3mp71r-us-east-1/20190732wl-new.templatexloywxxyimi&stackName=doccano)
+    * > Notice: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/chakki-works/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).
 2. [Use Docker](https://docs.docker.com/install/)
-   * Docker doesn't bother you by the OS, Python version, etc problems. Because an environment for application is packed as a container.
-   * Get doccano's image: `docker pull chakkiworks/doccano`
-   * Create & Run doccano container: `docker run -d --name doccano -p 8000:80 chakkiworks/doccano`
-   * Create a user: `docker exec doccano tools/create-admin.sh "admin" "admin@example.com" "password"`
-   * Stop doccano container: `docker stop doccano`
-   * Re-Launch doccano container: `docker start doccano`
+    * Docker doesn't bother you by the OS, Python version, etc problems. Because an environment for application is packed as a container.
+    * Get doccano's image: `docker pull chakkiworks/doccano`
+    * Create & Run doccano container: `docker run -d --name doccano -p 8000:80 chakkiworks/doccano`
+    * Create a user: `docker exec doccano tools/create-admin.sh "admin" "admin@example.com" "password"`
+    * Stop doccano container: `docker stop doccano`
+    * Re-Launch doccano container: `docker start doccano`
 3. Install from source
-   * **I want to remember you that this is the hardest setup way. You have to install Python/Node.js and type many commands.**
-   * [Install Python](https://www.python.org/downloads/)
-   * [Install Node.js](https://nodejs.org/en/download/)
-   * Get the source code of doccano: `git clone https://github.com/chakki-works/doccano.git`
-   * Move to doccano directory: `cd doccano`
-   * Create environment for doccano: `virtualenv venv`
-   * Activate environment: `source venv/bin/activate`
-   * Install required packages: `pip install -r requirements.txt`
-   * Move server directory: `cd app/server`
-   * Build frontend library: `npm install`
-   * Build frontend source code: `npm run build`
-   * Back to server directory: `cd ../`
-   * Initialize doccano: `python manage.py migrate`
-   * Create user: `python manage.py createsuperuser`
-   * Run doccano: `python manage.py runserver`
-   * Stop doccano: Ctrl+C
-   * Re-Launch doccano: `python manage.py runserver` (Confirm you are at `app/server` directory and environment is active).
+    * **I want to remember you that this is the hardest setup way. You have to install Python/Node.js and type many commands.**
+    * [Install Python](https://www.python.org/downloads/)
+    * [Install Node.js](https://nodejs.org/en/download/)
+    * Get the source code of doccano: `git clone https://github.com/chakki-works/doccano.git`
+    * Move to doccano directory: `cd doccano`
+    * Create environment for doccano: `virtualenv venv`
+    * Activate environment: `source venv/bin/activate`
+    * Install required packages: `pip install -r requirements.txt`
+    * Move server directory: `cd app/server`
+    * Build frontend library: `npm install`
+    * Build frontend source code: `npm run build`
+    * Back to server directory: `cd ../`
+    * Initialize doccano: `python manage.py migrate`
+    * Create user: `python manage.py createsuperuser`
+    * Run doccano: `python manage.py runserver`
+    * Stop doccano: Ctrl+C
+    * Re-Launch doccano: `python manage.py runserver` (Confirm you are at `app/server` directory and environment is active).
 
 ## I can't upload my data.
 

docs/index.md

@@ -1,17 +1,17 @@
 # Welcome to doccano
 
-## Text Annotation for Human
+## Text Annotation for Humans
 
-doccano is an open source text annotation tool for human. It provides annotation features for text classification, sequence labeling and sequence to sequence. So, you can create labeled data for sentiment analysis, named entity recognition, text summarization and so on. Just create project, upload data and start annotation. You can build dataset in hours.
+doccano is an open source text annotation tool built for human beings. It provides annotation features for text classification, sequence labeling and sequence to sequence. So, you can create labeled data for sentiment analysis, named entity recognition, text summarization and so on. Just create project, upload your data and start annotating. You can build a dataset in hours.
 
 
 ## Demo
 
-You can enjoy [annotation demo](http://doccano.herokuapp.com).
+You can enjoy this [annotation demo](http://doccano.herokuapp.com).
 
 ### [Named entity recognition](https://doccano.herokuapp.com/demo/named-entity-recognition/)
 
-First demo is one of the sequence labeling tasks, named-entity recognition. You just select text spans and annotate it. Since doccano supports shortcut key, so you can quickly annotate text spans.
+First demo is one of the sequence labeling tasks, named-entity recognition. You just select text spans and annotate them. Since doccano supports shortcut keys, you can quickly annotate text spans.
 
 ![Named Entity Recognition](./named_entity_annotation.gif)
 
@@ -23,7 +23,7 @@ Second demo is one of the text classification tasks, topic classification. Since
 
 ### [Machine translation](https://doccano.herokuapp.com/demo/translation/)
 
-Final demo is one of the sequence to sequence tasks, machine translation. Since there may be more than one responses in sequence to sequence tasks, you can create multi responses.
+Final demo is one of the sequence to sequence tasks, machine translation. Since there may be more than one responses in sequence to sequence tasks, you can create multiple responses.
 
 ![Machine Translation](./translation.gif)
 

docs/roadmap.md

@@ -1,4 +1,4 @@
-# Introduction
+# Roadmap
 
 Doccano is a fast-moving, community supported project. This roadmap provides guidance about priorities and focus areas of the doccano team and lists the functionality expected in upcoming releases of doccano. Many of these areas are driven by community use cases, and we welcome further contributions to doccano.
 

mkdocs.yml

@@ -1,6 +1,6 @@
 # Project information
 site_name: 'doccano'
-site_description: 'A Text Annotation tool for Human'
+site_description: 'A Text Annotation tool for Humans'
 site_author: 'Hiroki Nakayama'
 site_url: 'https://chakki-works.github.io/doccano/'
 
@@ -36,7 +36,5 @@ nav:
   #- Release notes: release-notes.md
   #- Author's notes: authors-notes.md
   - FAQ: faq.md
-  - Contributing: CONTRIBUTING.md
   - Code of Conduct: CODE_OF_CONDUCT.md
   - Roadmap: roadmap.md
-  - License: LICENSE.md