add an index and go make some small tweaks

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

api/README.md

@@ -55,3 +55,10 @@ DELETE "/images/{name:.*}"
 
 * `GET "/containers/json"` : Containers started from the `swarm` official image are hidden by default, use `all=1` to display them.
 
+
+## Docker Swarm documentation index
+
+- [User guide](./index.md)
+- [Discovery options](./discovery.md)
+- [Sheduler strategies](./scheduler/strategy.md)
+- [Sheduler filters](./scheduler/filter.md)

discovery/README.md

@@ -138,8 +138,8 @@ $ swarm list zk://<zookeeper_addr1>,<zookeeper_addr2>/<path>
 ```bash
 # start the manager on any machine or your laptop
 $ swarm manage -H <swarm_ip:swarm_port> nodes://<node_ip1:2375>,<node_ip2:2375>
-#or
-$ swarm manage -H <swarm_ip:swarm_port> nodes://<node_ip1:2375>,<node_ip2:2375>
+# or
+$ swarm manage -H <swarm_ip:swarm_port> <node_ip1:2375>,<node_ip2:2375>
 
 # use the regular docker cli
 $ docker -H <swarm_ip:swarm_port> info
@@ -149,7 +149,7 @@ $ docker -H <swarm_ip:swarm_port> logs ...
 ...
 ```
 
-## Contributing
+## Contributing a new discovery backend
 
 Contributing a new discovery backend is easy,
 simply implements this interface:
@@ -163,17 +163,22 @@ type DiscoveryService interface {
 }
 ```
 
-## Extra tips
-
 ### Initialize
-take the `discovery` without the scheme and a heartbeat (in seconds)
+The parameters are `discovery` location without the scheme and a heartbeat (in seconds)
 
 ### Fetch
-returns the list of all the nodes from the discovery
+Returns the list of all the nodes from the discovery
 
 ### Watch
-triggers an update (`Fetch`),it can happen either via
+Triggers an update (`Fetch`). This can happen either via
 a timer (like `token`) or use backend specific features (like `etcd`)
 
 ### Register
-add a new node to the discovery
+Add a new node to the discovery service.
+
+## Docker Swarm documentation index
+
+- [User guide](./index.md)
+- [Sheduler strategies](./scheduler/strategy.md)
+- [Sheduler filters](./scheduler/filter.md)
+- [Swarm API](./API.md)

docs/index.md

@@ -97,3 +97,9 @@ See the [Discovery service](discovery.md) document for more information.
 
 See [filters](scheduler/filter.md) and [strategies](scheduler/strategy.md) to learn
 more about advanced scheduling.
+
+## Swarm API
+
+The [Docker Swarm API](API.md) is compatible with the [Docker
+remote API](http://docs.docker.com/reference/api/docker_remote_api/), and extends it
+with some new endpoints.

scheduler/filter/README.md

@@ -258,3 +258,10 @@ different nodes, Swarm will prevent you from scheduling the container.
 ## Health Filter
 
 This filter will prevent scheduling containers on unhealthy nodes.
+
+## Docker Swarm documentation index
+
+- [User guide](./../index.md)
+- [Discovery options](./../discovery.md)
+- [Sheduler strategies](./strategy.md)
+- [Swarm API](./../API.md)

scheduler/strategy/README.md

@@ -54,3 +54,11 @@ already. This allows us to start a container requiring 2G of RAM on `node-2`.
 ## Random strategy
 
 The Random strategy, as it's name says, chose a random node, it's used mainly for debug.
+
+## Docker Swarm documentation index
+
+
+- [User guide](./../index.md)
+- [Discovery options](./../discovery.md)
+- [Sheduler filters](./filter.md)
+- [Swarm API](./../API.md)