Documentation and setup updates for v1.1 (#780)

* Add missing pages to documentations & minor edits

* Pin down v1.1 version into docs and docker-related files

* Update Upgrade guide on readme

* Language fixes

README.md

@@ -4,6 +4,7 @@
 
 [![](https://img.shields.io/circleci/project/github/omisego/ewallet/master.svg)](https://circleci.com/gh/omisego/ewallet/tree/master)
 [![](https://img.shields.io/gitter/room/omisego/ewallet.svg)](https://gitter.im/omisego/ewallet)
+[![](https://badge.waffle.io/omisego/ewallet.svg?columns=Cycle%20To%20Do,In%20Progress,Review,Done)](https://waffle.io/omisego/ewallet)
 
 **OmiseGO eWallet Server** is a server application in OmiseGO eWallet Suite that allows a provider (businesses or individuals) to setup and run their own digital wallet services through a local ledger, and to a decentralized blockchain exchange in the future to form a federated network on the OMG network allowing exchange of any currency into any other in a transparent way.
 
@@ -13,16 +14,16 @@ The quickest way to get OmiseGO eWallet Server running on macOS and Linux is to
 
 1. Install [Docker](https://docs.docker.com/install/) and [Docker-Compose](https://docs.docker.com/compose/install/)
 
-2. Download OmiseGO eWallet Server's [docker-compose.yml](https://raw.githubusercontent.com/omisego/ewallet/master/docker-compose.yml):
+2. Download OmiseGO eWallet Server's [docker-compose.yml](https://raw.githubusercontent.com/omisego/ewallet/v1.1/docker-compose.yml):
 
     ```shell
-    curl -O -sSL https://raw.githubusercontent.com/omisego/ewallet/master/docker-compose.yml
+    curl -O -sSL https://raw.githubusercontent.com/omisego/ewallet/v1.1/docker-compose.yml
     ```
 
-3. Create `docker-compose.override.yml` either [manually](https://docs.docker.com/compose/extends/) or use auto-configuration script:
+3. Create `docker-compose.override.yml` either [manually](https://docs.docker.com/compose/extends/) or use this auto-configuration script:
 
     ```
-    curl -O -sSL https://raw.githubusercontent.com/omisego/ewallet/master/docker-gen.sh
+    curl -O -sSL https://raw.githubusercontent.com/omisego/ewallet/v1.1/docker-gen.sh
     chmod +x docker-gen.sh
     ./docker-gen.sh > docker-compose.override.yml
     ```
@@ -35,15 +36,18 @@ The quickest way to get OmiseGO eWallet Server running on macOS and Linux is to
     docker-compose up -d
     ```
 
-For other platforms or for a more advanced setup, see also manual installation below.
+Encountered a problem during the installation? See the [Setup Troubleshooting Guide](docs/setup/troubleshooting.md).
+
+For other platforms or a more advanced setup, see alternative installation below.
 
 ### Alternative installation
 
 -   [Bare metal installation](docs/setup/bare_metal.md)
 
-### Upgrade
+## Upgrade
 
-Upgrading to a newer version? See [Upgrading the eWallet Server](docs/setup/upgrading).
+- Upgrading from `v1.0`? See [Upgrading from v1.0.0 to v1.1.0](docs/setup/upgrading/v1.1.0.md).
+- Upgrading from other versions? See [Upgrading the eWallet Server](docs/setup/upgrading).
 
 ## Commands
 
@@ -85,13 +89,7 @@ These commands will update the configuration key (see also [settings documentati
 
 ## Documentation
 
-### Setup documentation
-
-The documentation that covers configurations and design philosophy can be found in the [docs](docs/) directory of this repository. You are recommended to take a look at a documentation of respective version of OmiseGO eWallet Server you are running.
-
--   [latest](https://github.com/omisego/ewallet/tree/master/docs)
--   [v1.1](https://github.com/omisego/ewallet/tree/v1.1/docs)
--   [v1.0](https://github.com/omisego/ewallet/tree/v1.0/docs)
+All documentations can found in the [docs](docs/) directory. It is recommended to take a look at the documentation of the OmiseGO eWallet Server you are running.
 
 ### API documentation
 

docker-compose.yml

@@ -25,7 +25,7 @@ services:
       - "8025:8025"
 
   ewallet:
-    image: omisego/ewallet:latest
+    image: omisego/ewallet:stable
     restart: always
     networks:
       - intnet

docker-gen.sh

@@ -62,9 +62,9 @@ done
 
 if [ -z "$IMAGE_NAME" ]; then
    if [ $DEV_MODE = 1 ]; then
-       IMAGE_NAME="omisegoimages/ewallet-builder:stable"
+       IMAGE_NAME="omisegoimages/ewallet-builder:v1.1"
    else
-       IMAGE_NAME="omisego/ewallet:latest"
+       IMAGE_NAME="omisego/ewallet:v1.1-dev"
    fi
 fi
 

docs/README.md

@@ -0,0 +1,10 @@
+# Documentation
+
+Below are the main areas of the documentation. Navigate through the links below to see more details.
+
+- **[Design](design/):** Design and philosophy behind the eWallet Server.
+- **[Guides](guides/):** Using the eWallet Server to its full potential.
+- **[Setup](setup/):** Details on the different eWallet Server setup approaches.
+- **[Running the tests](tests/):** Running the tests bundled with the eWallet Server.
+- **[Demo](demo.md):** Sample setup that demonstrates how the eWallet Server can be used.
+- **[FAQ](faq.md):** Top frequently asked questions about the eWallet Server.

docs/design/design.md → docs/design/README.md

@@ -1,6 +1,6 @@
 # Technical Design
 
-Learn more about how the eWallet server is built and its design decisions:
+Learn more about how the eWallet Server is built and its design decisions:
 
 - [Components](components.md)
 - [Databases](databases.md)

docs/guides/guides.md → docs/guides/README.md

@@ -1,6 +1,6 @@
 # Guides
 
-Take a deeper dive into the eWallet. Here are some resources to learn more about how the eWallet works.
+Take a deeper dive into the eWallet. Learn more about how to use the eWallet Server to its full potential.
 
 - [Usage](/docs/guides/usage.md): Start integrating your eWallet server to your application
 - [API Responsibilities](/docs/guides/api_responsibilities.md): Learn what responsibilities are taken care by the eWallet and what could be built on top of it.

docs/setup/README.md

@@ -0,0 +1,13 @@
+# Setup
+
+See [Getting started](../../#getting-started) for our recommended way to setup the eWallet Server.
+
+The following links cover the setup in more details.
+
+- [Bare-metal setup](bare_metal.md).
+- [Upgrading](upgrading/)
+- [Settings](advanced/settings.md)
+- [Environment variables](advanced/env.md)
+- [Generating API specifications](advanced/api_specs.md)
+- [Clustering](advanced/clustering.md)
+- [Troubleshooting](troubleshooting.md)

docs/setup/advanced/api_specs.md

@@ -1,4 +1,4 @@
-# API Specifications
+# Generating API Specifications
 
 OpenAPI definitions, allow devs to specify the operations and metadata of their APIs in machine-readable form. This enables them to automate various processes around the API lifecycle.