jyapayne/compose
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1623 from mnowster/documentation-fixes

Browse source 
Documentation fixes
This commit is contained in:
Aanand Prasad 2015-07-06 13:25:56 +01:00
commit 0fa5808389
5 changed files with 59 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/README.md
View file

@ -12,7 +12,7 @@ If you want to add a new file or change the location of the document in the menu
2. Save your changes.
3. Make sure you in your `docs` subdirectory.
3. Make sure you are in the `docs` subdirectory.
4. Build the documentation.
@ -41,7 +41,7 @@ If you want to add a new file or change the location of the document in the menu
## Tips on Hugo metadata and menu positioning
The top of each Docker Compose documentation file contains TOML metadata. The metadata is commented out to prevent it from appears in GitHub.
The top of each Docker Compose documentation file contains TOML metadata. The metadata is commented out to prevent it from appearing in GitHub.
<!--[metadata]>
+++

15
docs/index.md
View file

@ -75,11 +75,11 @@ Next, you'll want to make a directory for the project:
$ cd composetest
Inside this directory, create `app.py`, a simple web app that uses the Flask
framework and increments a value in Redis:
framework and increments a value in Redis. Don't worry if you don't have Redis installed, docker is going to take care of that for you when we [define services](#define-services):
from flask import Flask
from redis import Redis
import os
app = Flask(__name__)
redis = Redis(host='redis', port=6379)
@ -159,10 +159,13 @@ Now, when you run `docker-compose up`, Compose will pull a Redis image, build an
Starting composetest_web_1...
redis_1 | [8] 02 Jan 18:43:35.576 # Server started, Redis version 2.8.3
web_1 | * Running on http://0.0.0.0:5000/
web_1 | * Restarting with stat
The web app should now be listening on port 5000 on your Docker daemon host (if
you're using Boot2docker, `boot2docker ip` will tell you its address). In a browser,
open `http://ip-from-boot2docker:5000` and you should get a message in your browser saying:
If you're using [Boot2docker](https://github.com/boot2docker/boot2docker), then `boot2docker ip` will tell you its address and you can open `http://ip-from-boot2docker:5000` in a browser.
If you're not using Boot2docker and are on linux, then the web app should now be listening on port 5000 on your Docker daemon host. If http://0.0.0.0:5000 doesn't resolve, you can also try localhost:5000.
You should get a message in your browser saying:
`Hello World! I have been seen 1 times.`
@ -187,7 +190,7 @@ services. For example, to see what environment variables are available to the
$ docker-compose run web env
See `docker-compose --help` to see other available commands.
See `docker-compose --help` to see other available commands. You can also install [command completion](completion.md) for the bash and zsh shell, which will also show you available commands.
If you started Compose with `docker-compose up -d`, you'll probably want to stop
your services once you've finished with them: