Run pre-commit on all files
Signed-off-by: Daniel Nephin <dnephin@gmail.com>
This commit is contained in:
parent
fae6454661
commit
59d4f304ee
64 changed files with 250 additions and 223 deletions
|
|
@ -1,8 +1,8 @@
|
|||
# Contributing to the Docker Compose documentation
|
||||
|
||||
The documentation in this directory is part of the [https://docs.docker.com](https://docs.docker.com) website. Docker uses [the Hugo static generator](http://gohugo.io/overview/introduction/) to convert project Markdown files to a static HTML site.
|
||||
The documentation in this directory is part of the [https://docs.docker.com](https://docs.docker.com) website. Docker uses [the Hugo static generator](http://gohugo.io/overview/introduction/) to convert project Markdown files to a static HTML site.
|
||||
|
||||
You don't need to be a Hugo expert to contribute to the compose documentation. If you are familiar with Markdown, you can modify the content in the `docs` files.
|
||||
You don't need to be a Hugo expert to contribute to the compose documentation. If you are familiar with Markdown, you can modify the content in the `docs` files.
|
||||
|
||||
If you want to add a new file or change the location of the document in the menu, you do need to know a little more.
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ If you want to add a new file or change the location of the document in the menu
|
|||
docker run --rm -it -e AWS_S3_BUCKET -e NOCACHE -p 8000:8000 -e DOCKERHOST "docs-base:test-tooling" hugo server --port=8000 --baseUrl=192.168.59.103 --bind=0.0.0.0
|
||||
ERROR: 2015/06/13 MenuEntry's .Url is deprecated and will be removed in Hugo 0.15. Use .URL instead.
|
||||
0 of 4 drafts rendered
|
||||
0 future content
|
||||
0 future content
|
||||
12 pages created
|
||||
0 paginator pages created
|
||||
0 tags created
|
||||
|
|
@ -52,7 +52,7 @@ The top of each Docker Compose documentation file contains TOML metadata. The me
|
|||
parent="smn_workw_compose"
|
||||
weight=2
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
<![end-metadata]-->
|
||||
|
||||
The metadata alone has this structure:
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ The metadata alone has this structure:
|
|||
parent="smn_workw_compose"
|
||||
weight=2
|
||||
+++
|
||||
|
||||
|
||||
The `[menu.main]` section refers to navigation defined [in the main Docker menu](https://github.com/docker/docs-base/blob/hugo/config.toml). This metadata says *add a menu item called* Extending services in Compose *to the menu with the* `smn_workdw_compose` *identifier*. If you locate the menu in the configuration, you'll find *Create multi-container applications* is the menu title.
|
||||
|
||||
You can move an article in the tree by specifying a new parent. You can shift the location of the item by changing its weight. Higher numbers are heavier and shift the item to the bottom of menu. Low or no numbers shift it up.
|
||||
|
|
@ -73,5 +73,5 @@ You can move an article in the tree by specifying a new parent. You can shift th
|
|||
## Other key documentation repositories
|
||||
|
||||
The `docker/docs-base` repository contains [the Hugo theme and menu configuration](https://github.com/docker/docs-base). If you open the `Dockerfile` you'll see the `make docs` relies on this as a base image for building the Compose documentation.
|
||||
|
||||
|
||||
The `docker/docs.docker.com` repository contains [build system for building the Docker documentation site](https://github.com/docker/docs.docker.com). Fork this repository to build the entire documentation site.
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@ Now, when you run `docker-compose up`, Compose will pull a Redis image, build an
|
|||
web_1 | * Running on http://0.0.0.0:5000/
|
||||
web_1 | * Restarting with stat
|
||||
|
||||
If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` will tell you its address and you can open `http://MACHINE_VM_IP:5000` in a browser.
|
||||
If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` will tell you its address and you can open `http://MACHINE_VM_IP: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.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ weight=4
|
|||
|
||||
You can run Compose on OS X and 64-bit Linux. It is currently not supported on
|
||||
the Windows operating system. To install Compose, you'll need to install Docker
|
||||
first.
|
||||
first.
|
||||
|
||||
Depending on how your system is configured, you may require `sudo` access to
|
||||
install Compose. If your system requires `sudo`, you will receive "Permission
|
||||
|
|
@ -26,13 +26,13 @@ To install Compose, do the following:
|
|||
1. Install Docker Engine version 1.7.1 or greater:
|
||||
|
||||
* <a href="https://docs.docker.com/installation/mac/" target="_blank">Mac OS X installation</a> (installs both Engine and Compose)
|
||||
|
||||
|
||||
* <a href="https://docs.docker.com/installation/ubuntulinux/" target="_blank">Ubuntu installation</a>
|
||||
|
||||
|
||||
* <a href="https://docs.docker.com/installation/" target="_blank">other system installations</a>
|
||||
|
||||
|
||||
2. Mac OS X users are done installing. Others should continue to the next step.
|
||||
|
||||
|
||||
3. Go to the <a href="https://github.com/docker/compose/releases" target="_blank">repository release page</a>.
|
||||
|
||||
4. Enter the `curl` command in your termial.
|
||||
|
|
@ -40,9 +40,9 @@ To install Compose, do the following:
|
|||
The command has the following format:
|
||||
|
||||
curl -L https://github.com/docker/compose/releases/download/VERSION_NUM/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
|
||||
|
||||
|
||||
If you have problems installing with `curl`, you can use `pip` instead: `pip install -U docker-compose`
|
||||
|
||||
|
||||
4. Apply executable permissions to the binary:
|
||||
|
||||
$ chmod +x /usr/local/bin/docker-compose
|
||||
|
|
@ -85,7 +85,7 @@ To uninstall Docker Compose if you installed using `curl`:
|
|||
To uninstall Docker Compose if you installed using `pip`:
|
||||
|
||||
$ pip uninstall docker-compose
|
||||
|
||||
|
||||
>**Note**: If you get a "Permission denied" error using either of the above
|
||||
>methods, you probably do not have the proper permissions to remove
|
||||
>`docker-compose`. To force the removal, prepend `sudo` to either of the above
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ content_dir=(`ls -d /docs/content/*`)
|
|||
# 5 Change ](word) to ](/project/word)
|
||||
# 6 Change ](../../ to ](/project/
|
||||
# 7 Change ](../ to ](/project/word)
|
||||
#
|
||||
#
|
||||
for i in "${content_dir[@]}"
|
||||
do
|
||||
:
|
||||
|
|
@ -51,11 +51,10 @@ done
|
|||
for i in "${docker_dir[@]}"
|
||||
do
|
||||
:
|
||||
if [ -d $i ]
|
||||
if [ -d $i ]
|
||||
then
|
||||
mv $i /docs/content/
|
||||
mv $i /docs/content/
|
||||
fi
|
||||
done
|
||||
|
||||
rm -rf /docs/content/docker
|
||||
|
||||
|
|
|
|||
|
|
@ -93,4 +93,3 @@ guide</a>.
|
|||
- [Yaml file reference](yml.md)
|
||||
- [Compose environment variables](env.md)
|
||||
- [Compose command line completion](completion.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ Finally, you need to create the database. In another terminal, run:
|
|||
|
||||
$ docker-compose run web rake db:create
|
||||
|
||||
That's it. Your app should now be running on port 3000 on your Docker daemon. If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` returns the Docker host IP address.
|
||||
That's it. Your app should now be running on port 3000 on your Docker daemon. If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` returns the Docker host IP address.
|
||||
|
||||
|
||||
## More Compose documentation
|
||||
|
|
|
|||
|
|
@ -20,4 +20,4 @@ Options:
|
|||
|
||||
Services are built once and then tagged as `project_service`, e.g.,
|
||||
`composetest_db`. If you change a service's Dockerfile or the contents of its
|
||||
build directory, run `docker-compose build` to rebuild it.
|
||||
build directory, run `docker-compose build` to rebuild it.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description = "docker-compose Command Binary"
|
|||
keywords = ["fig, composition, compose, docker, orchestration, cli, docker-compose"]
|
||||
[menu.main]
|
||||
parent = "smn_compose_cli"
|
||||
weight=-2
|
||||
weight=-2
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description = "Compose CLI reference"
|
|||
keywords = ["fig, composition, compose, docker, orchestration, cli, reference"]
|
||||
[menu.main]
|
||||
identifier = "smn_compose_cli"
|
||||
parent = "smn_compose_ref"
|
||||
parent = "smn_compose_ref"
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ The following pages describe the usage information for the [docker-compose](/ref
|
|||
|
||||
* [build](/reference/build.md)
|
||||
* [help](/reference/help.md)
|
||||
* [kill](/reference/kill.md)
|
||||
* [kill](/reference/kill.md)
|
||||
* [ps](/reference/ps.md)
|
||||
* [restart](/reference/restart.md)
|
||||
* [run](/reference/run.md)
|
||||
|
|
@ -23,7 +23,7 @@ The following pages describe the usage information for the [docker-compose](/ref
|
|||
* [up](/reference/up.md)
|
||||
* [logs](/reference/logs.md)
|
||||
* [port](/reference/port.md)
|
||||
* [pull](/reference/pull.md)
|
||||
* [pull](/reference/pull.md)
|
||||
* [rm](/reference/rm.md)
|
||||
* [scale](/reference/scale.md)
|
||||
* [stop](/reference/stop.md)
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ Options:
|
|||
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the
|
||||
signal can be passed, for example:
|
||||
|
||||
$ docker-compose kill -s SIGINT
|
||||
$ docker-compose kill -s SIGINT
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description = "Introduction to the CLI"
|
|||
keywords = ["fig, composition, compose, docker, orchestration, cli, reference"]
|
||||
[menu.main]
|
||||
parent = "smn_compose_cli"
|
||||
weight=-2
|
||||
weight=-2
|
||||
+++
|
||||
<![end-metadata]-->
|
||||
|
||||
|
|
|
|||
|
|
@ -20,4 +20,4 @@ Options:
|
|||
instances of a service [default: 1]
|
||||
```
|
||||
|
||||
Prints the public port for a port binding.
|
||||
Prints the public port for a port binding.
|
||||
|
|
|
|||
|
|
@ -15,4 +15,4 @@ parent = "smn_compose_cli"
|
|||
Usage: pull [options] [SERVICE...]
|
||||
```
|
||||
|
||||
Pulls service images.
|
||||
Pulls service images.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ Options:
|
|||
-T Disable pseudo-tty allocation. By default `docker-compose run` allocates a TTY.
|
||||
```
|
||||
|
||||
Runs a one-time command against a service. For example, the following command starts the `web` service and runs `bash` as its command.
|
||||
Runs a one-time command against a service. For example, the following command starts the `web` service and runs `bash` as its command.
|
||||
|
||||
$ docker-compose run web bash
|
||||
|
||||
|
|
@ -52,7 +52,3 @@ This would open up an interactive PostgreSQL shell for the linked `db` container
|
|||
If you do not want the `run` command to start linked containers, specify the `--no-deps` flag:
|
||||
|
||||
$ docker-compose run --no-deps web python manage.py shell
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -18,4 +18,4 @@ Sets the number of containers to run for a service.
|
|||
|
||||
Numbers are specified as arguments in the form `service=num`. For example:
|
||||
|
||||
$ docker-compose scale web=2 worker=3
|
||||
$ docker-compose scale web=2 worker=3
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ weight=6
|
|||
# Quickstart Guide: Compose and Wordpress
|
||||
|
||||
You can use Compose to easily run Wordpress in an isolated environment built
|
||||
with Docker containers.
|
||||
with Docker containers.
|
||||
|
||||
## Define the project
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ your Dockerfile should be:
|
|||
ADD . /code
|
||||
|
||||
This tells Docker how to build an image defining a container that contains PHP
|
||||
and Wordpress.
|
||||
and Wordpress.
|
||||
|
||||
Next you'll create a `docker-compose.yml` file that will start your web service
|
||||
and a separate MySQL instance:
|
||||
|
|
@ -108,7 +108,7 @@ Second, `router.php` tells PHP's built-in web server how to run Wordpress:
|
|||
|
||||
With those four files in place, run `docker-compose up` inside your Wordpress
|
||||
directory and it'll pull and build the needed images, and then start the web and
|
||||
database containers. If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` gives you the machine address and you can open `http://MACHINE_VM_IP:8000` in a browser.
|
||||
database containers. If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` gives you the machine address and you can open `http://MACHINE_VM_IP:8000` in a browser.
|
||||
|
||||
## More Compose documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ As with `docker run`, options specified in the Dockerfile (e.g., `CMD`,
|
|||
`EXPOSE`, `VOLUME`, `ENV`) are respected by default - you don't need to
|
||||
specify them again in `docker-compose.yml`.
|
||||
|
||||
Values for configuration options can contain environment variables, e.g.
|
||||
Values for configuration options can contain environment variables, e.g.
|
||||
`image: postgres:${POSTGRES_VERSION}`. For more details, see the section on
|
||||
[variable substitution](#variable-substitution).
|
||||
|
||||
|
|
@ -353,7 +353,7 @@ Custom DNS search domains. Can be a single value or a list.
|
|||
|
||||
### devices
|
||||
|
||||
List of device mappings. Uses the same format as the `--device` docker
|
||||
List of device mappings. Uses the same format as the `--device` docker
|
||||
client create option.
|
||||
|
||||
devices:
|
||||
|
|
@ -433,4 +433,3 @@ dollar sign (`$$`).
|
|||
- [Command line reference](/reference)
|
||||
- [Compose environment variables](env.md)
|
||||
- [Compose command line completion](completion.md)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue