Standardize on site-wide variables for Docker and component versions (#4792)

This commit is contained in:
Misty Stanley-Jones 2017-10-05 16:36:03 -07:00 committed by GitHub
parent acda699725
commit b02cca86cf
18 changed files with 49 additions and 61 deletions

View File

@ -13,11 +13,13 @@ lsi: false
url: https://docs.docker.com
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11", "v1.12", "v1.13", "v17.03", "v17.06"]
# Component versions -- address like site.data.engine_version
engine_version: "17.09"
#compose_version: ""
#machine_version: ""
#registry_version: ""
# Component versions -- address like site.docker-ce_stable_version
docker-ce_stable_version: "17.09"
docker-ce_edge_version: "17.09"
docker-ee_version: "17.06"
compose_version: "1.16.1"
machine_version: "0.12.2"
distribution_version: "2.6"
collections:
samples:

View File

@ -1,7 +1,6 @@
{% assign d4a_stable = "CE-Stable-1" %}
{% assign d4a_edge = "CE-Edge-1" %}
{% assign d4a_test = "CE-Test-1" %}
{% assign edition_version = "17.03.0-ce" %}
{% capture aws_blue_latest %}

View File

@ -151,7 +151,7 @@ You can install Docker EE in different ways, depending on your needs:
```bash
$ sudo yum list docker-ee --showduplicates | sort -r
docker-ee.x86_64 {{ minor-version }}.ee.2-1.el7.{{ linux-dist }} docker-ee-stable-17.06
docker-ee.x86_64 {{ site.docker-ee_version }}.ee.2-1.el7.{{ linux-dist }} docker-ee-stable-17.06
```
The contents of the list depend upon which repositories you have enabled,
@ -246,7 +246,7 @@ upgrade Docker EE.
1. Go to the Docker EE repository URL associated with your
trial or subscription in your browser. Go to
`{{ linux-dist-url-slug }}/7/x86_64/stable-{{ minor-version }}/Packages` and
`{{ linux-dist-url-slug }}/7/x86_64/stable-{{ site.docker-ee_version }}/Packages` and
download the `.{{ package-format | downcase }}` file for the Docker version
you want to install.

View File

@ -4,8 +4,6 @@ keywords: fig, composition, compose, docker, orchestration, cli, reference
title: Command-line completion
---
{% assign composeversion = '1.16.1' %}
Compose comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion)
for the bash and zsh shell.
@ -24,7 +22,7 @@ Place the completion script in `/etc/bash_completion.d/`
(or `/usr/local/etc/bash_completion.d/` on a Mac):
```shell
sudo curl -L https://raw.githubusercontent.com/docker/compose/{{composeversion}}/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose
sudo curl -L https://raw.githubusercontent.com/docker/compose/{{site.compose_version}}/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose
```
On a Mac, add the following to your `~/.bash_profile`:
@ -59,7 +57,7 @@ Place the completion script in your `/path/to/zsh/completion`, using e.g. `~/.zs
```shell
$ mkdir -p ~/.zsh/completion
$ curl -L https://raw.githubusercontent.com/docker/compose/{{composeversion}}/contrib/completion/zsh/_docker-compose > ~/.zsh/completion/_docker-compose
$ curl -L https://raw.githubusercontent.com/docker/compose/{{site.compose_version}}/contrib/completion/zsh/_docker-compose > ~/.zsh/completion/_docker-compose
```
Include the directory in your `$fpath`, e.g. by adding in `~/.zshrc`:

View File

@ -5,8 +5,6 @@ title: Install Docker Compose
toc_max: 2
---
{% assign composeversion = '1.16.1' %}
You can run Compose on macOS, Windows and 64-bit Linux.
## Prerequisites
@ -74,11 +72,11 @@ Docker Compose. To do so, follow these steps:
Invoke-WebRequest "https://github.com/docker/compose/releases/download/$dockerComposeVersion/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
```
For example, to download Compose version {{composeversion}},
For example, to download Compose version {{site.compose_version}},
the command is:
```none
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{composeversion}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
Invoke-WebRequest "https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\docker\docker-compose.exe
```
> Use the latest Compose release number in the download command.
>
@ -106,7 +104,7 @@ by step instructions are also included below.
1. Run this command to download the latest version of Docker Compose:
```bash
sudo curl -L https://github.com/docker/compose/releases/download/{{composeversion}}/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
sudo curl -L https://github.com/docker/compose/releases/download/{{site.compose_version}}/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
```
> Use the latest Compose release number in the download command.
@ -130,7 +128,7 @@ by step instructions are also included below.
```bash
$ docker-compose --version
docker-compose version {{composeversion}}, build 1719ceb
docker-compose version {{site.compose_version}}, build 1719ceb
```
<hr>
</div>
@ -169,7 +167,7 @@ install compose as a container run this command. Be sure to replace the version
number with the one that you want, if this example is out-of-date:
```bash
$ sudo curl -L --fail https://github.com/docker/compose/releases/download/{{composeversion}}/run.sh -o /usr/local/bin/docker-compose
$ sudo curl -L --fail https://github.com/docker/compose/releases/download/{{site.compose_version}}/run.sh -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
```

View File

@ -6,8 +6,6 @@ redirect_from:
- /engine/installation/binaries/
---
{% assign minor-version = "17.09" %}
> **Note**: You may have been redirected to this page because there is no longer
> a dynamically-linked Docker package for your Linux distribution.
@ -165,7 +163,7 @@ the `dockerd.exe` and `docker.exe` binaries are included.
1. Use the following PowerShell commands to install and start Docker:
```none
PS C:\> Invoke-WebRequest https://download.docker.com/win/static/stable/x86_64//docker-{{ minor-version }}.0-ce.zip -UseBasicParsing -OutFile docker.zip
PS C:\> Invoke-WebRequest https://download.docker.com/win/static/stable/x86_64//docker-{{ site.docker-ce_stable_version }}.0-ce.zip -UseBasicParsing -OutFile docker.zip
PS C:\> Expand-Archive docker.zip -DestinationPath $Env:ProgramFiles

View File

@ -6,8 +6,6 @@ redirect_from:
title: Get Docker CE for CentOS
---
{% assign minor-version = "17.09" %}
To get started with Docker CE on CentOS, make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker-ce).
@ -153,7 +151,7 @@ from the repository.
```bash
$ yum list docker-ce --showduplicates | sort -r
docker-ce.x86_64 {{ minor-version }}.ce-1.el7.centos docker-ce-stable
docker-ce.x86_64 {{ site.docker-ce_stable_version }}.ce-1.el7.centos docker-ce-stable
```
The contents of the list depend upon which repositories are enabled, and

View File

@ -8,8 +8,6 @@ redirect_from:
title: Get Docker CE for Debian
---
{% assign minor-version = "17.09" %}
To get started with Docker CE on Debian, make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker-ce).
@ -221,7 +219,7 @@ from the repository.
```bash
$ apt-cache madison docker-ce
docker-ce | {{ minor-version }}.0~ce-0~debian | https://download.docker.com/linux/debian jessie/stable amd64 Packages
docker-ce | {{ site.docker-ce_stable_version }}.0~ce-0~debian | https://download.docker.com/linux/debian jessie/stable amd64 Packages
```
The contents of the list depend upon which repositories are enabled. Choose

View File

@ -7,8 +7,6 @@ redirect_from:
title: Get Docker CE for Fedora
---
{% assign minor-version = "17.09" %}
To get started with Docker CE on Fedora, make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker).
@ -146,7 +144,7 @@ from the repository.
```bash
$ dnf list docker-ce --showduplicates | sort -r
docker-ce.x86_64 {{ minor-version }}.0.fc24 docker-ce-stable
docker-ce.x86_64 {{ site.docker-ce_stable_version }}.0.fc24 docker-ce-stable
```
The contents of the list depend upon which repositories are enabled, and

View File

@ -8,8 +8,6 @@ redirect_from:
title: Get Docker CE for Ubuntu
---
{% assign minor-version = "17.09" %}
To get started with Docker CE on Ubuntu, make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker).
@ -207,7 +205,7 @@ the repository.
```bash
$ apt-cache madison docker-ce
docker-ce | {{ minor-version }}.0~ce-0~ubuntu | {{ download-url-base }} xenial/stable amd64 Packages
docker-ce | {{ site.docker-ce_stable_version }}.0~ce-0~ubuntu | {{ download-url-base }} xenial/stable amd64 Packages
```
The contents of the list depend upon which repositories are enabled. Choose

View File

@ -6,7 +6,6 @@ redirect_from:
title: Get Docker EE for CentOS
---
{% assign minor-version = "17.06" %}
{% assign linux-dist = "centos" %}
{% assign linux-dist-url-slug = "centos" %}
{% assign linux-dist-long = "Centos" %}

View File

@ -7,7 +7,6 @@ redirect_from:
title: Get Docker EE for Oracle Linux
---
{% assign minor-version = "17.06" %}
{% assign linux-dist = "oraclelinux" %}
{% assign linux-dist-url-slug = "oraclelinux" %}
{% assign linux-dist-long = "Oracle Linux" %}

View File

@ -8,7 +8,6 @@ redirect_from:
title: Get Docker EE for Red Hat Enterprise Linux
---
{% assign minor-version = "17.06" %}
{% assign linux-dist = "rhel" %}
{% assign linux-dist-url-slug = "rhel" %}
{% assign linux-dist-long = "Red Hat Enterprise Linux" %}

View File

@ -7,8 +7,6 @@ redirect_from:
title: Get Docker EE for SLES
---
{% assign minor-version = "17.06" %}
To get started with Docker on SUSE Linux Enterprise Server (SLES), make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker-ee).
@ -120,7 +118,7 @@ from the repository.
```bash
$ sudo zypper addrepo \
<DOCKER-EE-URL>/sles/12.3/x86_64/stable-{{ minor-version }} \
<DOCKER-EE-URL>/sles/12.3/x86_64/stable-{{ site.docker-ee_version }} \
docker-ee-stable
```
@ -170,7 +168,7 @@ from the repository.
S | Name | Type | Version | Arch | Repository
--+---------------+---------+---------------------------------------+--------+---------------
| docker-ee | package | {{ minor-version }}-1 | x86_64 | docker-ee-stable
| docker-ee | package | {{ site.docker-ee_version }}-1 | x86_64 | docker-ee-stable
```
The contents of the list depend upon which repositories you have enabled.
@ -245,7 +243,7 @@ need to download a new file each time you want to upgrade Docker EE.
1. Go to the Docker EE repository URL associated with your
trial or subscription in your browser. Go to
`sles/12.3/x86_64/stable-{{ minor-version }}` and download the `.rpm` file for
`sles/12.3/x86_64/stable-{{ site.docker-ee_version }}` and download the `.rpm` file for
the Docker version you want to install.
2. Import Docker's official GPG key:

View File

@ -8,8 +8,6 @@ redirect_from:
title: Get Docker EE for Ubuntu
---
{% assign minor-version = "17.06" %}
To get started with Docker EE on Ubuntu, make sure you
[meet the prerequisites](#prerequisites), then
[install Docker](#install-docker-ee).
@ -145,7 +143,7 @@ from the repository.
$ sudo add-apt-repository \
"deb [arch=amd64] <DOCKER-EE-URL>/ubuntu \
$(lsb_release -cs) \
stable-{{ minor-version }}"
stable-{{ site.docker-ee_version }}"
```
**s390x**:
@ -154,7 +152,7 @@ from the repository.
$ sudo add-apt-repository \
"deb [arch=s390x] {{ download-url-base }} \
$(lsb_release -cs) \
stable-{{ minor-version }}"
stable-{{ site.docker-ee_version }}"
```
#### Install Docker EE
@ -187,7 +185,7 @@ from the repository.
```bash
$ apt-cache madison docker-ee
docker-ee | {{ minor-version }}.0~ee-0~ubuntu-xenial | <DOCKER-EE-URL>/ubuntu xenial/stable amd64 Packages
docker-ee | {{ site.docker-ee_version }}.0~ee-0~ubuntu-xenial | <DOCKER-EE-URL>/ubuntu xenial/stable amd64 Packages
```
The contents of the list depend upon which repositories are enabled,
@ -241,7 +239,7 @@ a new file each time you want to upgrade Docker EE.
1. Go to the Docker EE repository URL associated with your
trial or subscription in your browser. Go to
`ubuntu/x86_64/stable-{{ minor-version }}` and download the `.deb` file for the
`ubuntu/x86_64/stable-{{ site.docker-ee_version }}` and download the `.deb` file for the
Docker EE version you want to install.
2. Install Docker EE, changing the path below to the path where you downloaded

View File

@ -4,8 +4,6 @@ keywords: machine, docker, orchestration, cli, reference
title: Command-line completion
---
{% assign machineversion = '0.12.2' %}
Docker Machine comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion)
for the bash and zsh shell.
@ -23,13 +21,13 @@ Place the completion script in `/etc/bash_completion.d/` as follows:
* On a Mac:
```shell
sudo curl -L https://raw.githubusercontent.com/docker/machine/v{{machineversion}}/contrib/completion/bash/docker-machine.bash -o `brew --prefix`/etc/bash_completion.d/docker-machine
sudo curl -L https://raw.githubusercontent.com/docker/machine/v{{site.machine_version}}/contrib/completion/bash/docker-machine.bash -o `brew --prefix`/etc/bash_completion.d/docker-machine
```
* On a standard Linux installation:
```shell
sudo curl -L https://raw.githubusercontent.com/docker/machine/v{{machineversion}}/contrib/completion/bash/docker-machine.bash -o /etc/bash_completion.d/docker-machine
sudo curl -L https://raw.githubusercontent.com/docker/machine/v{{site.machine_version}}/contrib/completion/bash/docker-machine.bash -o /etc/bash_completion.d/docker-machine
```
Completion will be available upon next login.
@ -41,7 +39,7 @@ Place the completion script in your `/path/to/zsh/completion`, using e.g. `~/.zs
```shell
mkdir -p ~/.zsh/completion
curl -L https://raw.githubusercontent.com/docker/machine/v{{machineversion}}/contrib/completion/zsh/_docker-machine > ~/.zsh/completion/_docker-machine
curl -L https://raw.githubusercontent.com/docker/machine/v{{site.machine_version}}/contrib/completion/zsh/_docker-machine > ~/.zsh/completion/_docker-machine
```
Include the directory in your `$fpath`, e.g. by adding in `~/.zshrc`:

View File

@ -4,8 +4,6 @@ keywords: machine, orchestration, install, installation, docker, documentation,
title: Install Docker Machine
---
{% assign machineversion = '0.12.2' %}
On macOS and Windows, Machine is installed along with other Docker products when
you install the [Docker for Mac](/docker-for-mac/index.md), [Docker for
Windows](/docker-for-windows/index.md), or [Docker
@ -26,14 +24,14 @@ on GitHub.
If you are running on **macOS**:
```console
$ curl -L https://github.com/docker/machine/releases/download/v{{machineversion}}/docker-machine-`uname -s`-`uname -m` >/usr/local/bin/docker-machine && \
$ curl -L https://github.com/docker/machine/releases/download/v{{site.machine_version}}/docker-machine-`uname -s`-`uname -m` >/usr/local/bin/docker-machine && \
chmod +x /usr/local/bin/docker-machine
```
If you are running on **Linux**:
```console
$ curl -L https://github.com/docker/machine/releases/download/v{{machineversion}}/docker-machine-`uname -s`-`uname -m` >/tmp/docker-machine &&
$ curl -L https://github.com/docker/machine/releases/download/v{{site.machine_version}}/docker-machine-`uname -s`-`uname -m` >/tmp/docker-machine &&
chmod +x /tmp/docker-machine &&
sudo cp /tmp/docker-machine /usr/local/bin/docker-machine
```
@ -42,7 +40,7 @@ on GitHub.
```console
$ if [[ ! -d "$HOME/bin" ]]; then mkdir -p "$HOME/bin"; fi && \
curl -L https://github.com/docker/machine/releases/download/v{{machineversion}}/docker-machine-Windows-x86_64.exe > "$HOME/bin/docker-machine.exe" && \
curl -L https://github.com/docker/machine/releases/download/v{{site.machine_version}}/docker-machine-Windows-x86_64.exe > "$HOME/bin/docker-machine.exe" && \
chmod +x "$HOME/bin/docker-machine.exe"
```
@ -56,7 +54,7 @@ chmod +x "$HOME/bin/docker-machine.exe"
3. Check the installation by displaying the Machine version:
$ docker-machine version
docker-machine version {{machineversion}}, build 9371605
docker-machine version {{site.machine_version}}, build 9371605
## Installing bash completion scripts
@ -72,7 +70,7 @@ Confirm the version and save scripts to `/etc/bash_completion.d` or
`/usr/local/etc/bash_completion.d`:
```bash
scripts=( docker-machine-prompt.bash docker-machine-wrapper.bash docker-machine.bash ); for i in "${scripts[@]}"; do sudo wget https://raw.githubusercontent.com/docker/machine/v{{machineversion}}/contrib/completion/bash/${i} -P /etc/bash_completion.d; done
scripts=( docker-machine-prompt.bash docker-machine-wrapper.bash docker-machine.bash ); for i in "${scripts[@]}"; do sudo wget https://raw.githubusercontent.com/docker/machine/v{{site.machine_version}}/contrib/completion/bash/${i} -P /etc/bash_completion.d; done
```
To enable the `docker-machine` shell

14
test.md
View File

@ -209,7 +209,7 @@ setting styles directly on your tables! If you set the width on a `<td>`, you
only need to do it on the first one. If you have a `<th>`, set it there.
> **Note**: If you need to have **markdown** in a **HTML** table, add
> `markdown="1"` to the HTML for the `<td>` cells that contain the Markdown.
> `markdown="span"` to the HTML for the `<td>` cells that contain the Markdown.
<table>
<tr>
@ -245,6 +245,18 @@ To update glossary content, edit `_data/glossary.yaml`.
To link to a glossary term, link to `glossary.md?term=YourGlossaryTerm` (for
example, [swarm](glossary.md?term=swarm)).
## Site-wide variables
Look in the top-level `_config.yml` for site-wide variables, such as
`site.docker-ce_stable_version`. To use them, use Liquid like:
```liquid
{% raw %}{{ site.docker-ce_stable_version }}{% endraw %}
```
The current value of `site.docker-ce_stable_version` is
{{ site.docker-ce_stable_version }}.
## Mixing Markdown and HTML
You can use <b>span-level</b> HTML tags within Markdown.