Skip to content

Commit 558314b

Browse files
johndmulhausenjohndmulhausen
authored
Converges titles to imperative-form, front-matter based, and sentence-case (docker#438)
Multiple title fixes, consistency fixes, convergence into metadata-based titles.
1 parent 9bf89d4 commit 558314b

File tree

672 files changed

+2091
-5677
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

672 files changed

+2091
-5677
lines changed

‎_layouts/docs.html

+1
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@
185185
</div>
186186
<div {% if page.notoc %} class="col-xs-12 col-sm-9 col-md-10" {% else %} class="col-xs-12 col-sm-9 col-md-8 col-xl-9" {% endif %} >
187187
<section class="section" id="DocumentationText">
188+
{% if page.title %}<h1>{{ page.title }}</h1>{% endif %}
188189
{{ content }}
189190
{% if page.noratings != true %}
190191
<div style="text-align: center; margin-top: 50px">

‎apidocs/index.md

-8
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,9 @@
22
description: Learn how to use DTR APIs.
33
keywords:
44
- docker, registry, DTR, APIs
5-
menu:
6-
main:
7-
identifier: smn_dtrapi
8-
parent: workw_dtr
9-
weight: "100"
105
title: DTR APIs
11-
type: _default
126
---
137

14-
# DTR APIs
15-
168
This section includes the following topics:
179

1810
* [API overview](overview.md)

‎apidocs/overview.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,9 @@
22
description: Learn how to use DTR APIs.
33
keywords:
44
- docker, registry, DTR, APIs
5-
menu:
6-
main:
7-
identifier: dtr_api_overview
8-
parent: smn_dtrapi
9-
weight: 0
10-
title: Overview
11-
type: _default
5+
title: API overview
126
---
137

14-
# API Overview
15-
168
Docker Trusted Registry has an experimental API that you can use to manage
179
DTR repositories, permissions, and settings.
1810

‎compose/bundles.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
11
---
22
advisory: experimental
3-
description: Description of Docker and Compose's experimental support for application
4-
bundles
3+
description: Description of Docker and Compose's experimental support for application bundles
54
keywords:
65
- documentation, docs, docker, compose, bundles, stacks
7-
menu:
8-
main:
9-
parent: workw_compose
10-
title: Docker Stacks and Distributed Application Bundles
6+
title: Docker stacks and distributed application bundles (experimental)
117
---
128

13-
# Docker Stacks and Distributed Application Bundles (experimental)
14-
159
> **Note**: This is a copy of the [Docker Stacks and Distributed Application
1610
> Bundles](https://github.com/docker/docker/blob/v1.12.0-rc4/experimental/docker-stacks-and-bundles.md)
1711
> document in the [docker/docker repo](https://github.com/docker/docker).

‎compose/completion.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Compose CLI reference
33
keywords:
44
- fig, composition, compose, docker, orchestration, cli, reference
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 88
9-
title: Command-line Completion
5+
title: Command-line completion
106
---
117

12-
# Command-line Completion
13-
148
Compose comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion)
159
for the bash and zsh shell.
1610

‎compose/compose-file.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,9 @@ aliases:
44
description: Compose file reference
55
keywords:
66
- fig, composition, compose, docker
7-
menu:
8-
main:
9-
parent: workw_compose
10-
weight: 70
11-
title: Compose File Reference
7+
title: Compose file reference
128
---
139

14-
# Compose file reference
15-
1610
The Compose file is a [YAML](http://yaml.org/) file defining
1711
[services](compose-file.md#service-configuration-reference),
1812
[networks](compose-file.md#network-configuration-reference) and

‎compose/django.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Getting started with Docker Compose and Django
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 4
9-
title: 'Quickstart: Compose and Django'
5+
title: "Quickstart: Compose and Django"
106
---
117

12-
# Quickstart: Docker Compose and Django
13-
148
This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting, you'll need to have
159
[Compose installed](install.md).
1610

‎compose/env-file.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
---
2-
description: Declaring default environment variables in file
2+
description: Declare default environment variables in a file
33
keywords:
44
- fig, composition, compose, docker, orchestration, environment, env file
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 10
9-
title: Environment file
5+
title: Declare default environment variables in file
106
---
117

12-
# Environment file
13-
148
Compose supports declaring default environment variables in an environment
159
file named `.env` placed in the folder `docker-compose` command is executed from
1610
*(current working directory)*.

‎compose/environment-variables.md

-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: How to set, use and manage environment variables in Compose
33
keywords:
44
- fig, composition, compose, docker, orchestration, environment, variables, env file
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 10
95
title: Environment variables in Compose
106
---
117

12-
# Environment variables in Compose
13-
148
There are multiple parts of Compose that deal with environment variables in one sense or another. This page should help you find the information you need.
159

1610

‎compose/extends.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
---
2-
description: How to use Docker Compose's extends keyword to share configuration between
3-
files and projects
2+
description: How to use Docker Compose's extends keyword to share configuration between files and projects
43
keywords:
54
- fig, composition, compose, docker, orchestration, documentation, docs
6-
menu:
7-
main:
8-
parent: workw_compose
9-
weight: 20
10-
title: Extending Services in Compose
5+
title: Share Compose configurations between files and projects
116
---
127

13-
# Extending services and Compose files
14-
158
Compose supports two methods of sharing common configuration:
169

1710
1. Extending an entire Compose file by

‎compose/faq.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
---
22
description: Docker Compose FAQ
33
keywords: documentation, docs, docker, compose, faq
4-
menu:
5-
main:
6-
identifier: faq.compose
7-
parent: workw_compose
8-
weight: 90
9-
title: Frequently Asked Questions
4+
title: Frequently asked questions
105
---
116

12-
# Frequently asked questions
13-
147
If you don’t see your question here, feel free to drop by `#docker-compose` on
158
freenode IRC and ask the community.
169

‎compose/gettingstarted.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
---
2-
description: Getting started with Docker Compose
2+
description: Get started with Docker Compose
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: -85
9-
title: Getting Started
5+
title: Get started with Docker Compose
106
---
117

12-
# Getting Started
13-
148
On this page you build a simple Python web application running on Docker Compose. The
159
application uses the Flask framework and increments a value in Redis. While the
1610
sample uses Python, the concepts demonstrated here should be understandable even

‎compose/index.md

-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Introduction and Overview of Compose
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers
5-
menu:
6-
main:
7-
identifier: workw_compose
8-
weight: -70
95
title: Docker Compose
106
---
117

12-
# Docker Compose
13-
148
Compose is a tool for defining and running multi-container Docker applications. To learn more about Compose refer to the following documentation:
159

1610
- [Compose Overview](overview.md)

‎compose/install.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: How to install Docker Compose
33
keywords:
44
- compose, orchestration, install, installation, docker, documentation
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: -90
9-
title: Install Compose
5+
title: Install Docker Compose
106
---
117

12-
# Install Docker Compose
13-
148
You can run Compose on macOS, Windows and 64-bit Linux. To install it, you'll need to install Docker first.
159

1610
To install Compose, do the following:

‎compose/link-env-deprecated.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,9 @@ aliases:
44
description: Compose CLI reference
55
keywords:
66
- fig, composition, compose, docker, orchestration, cli, reference
7-
menu:
8-
main:
9-
parent: workw_compose
10-
weight: 89
11-
title: Link Environment Variables
7+
title: Link environment variables (superseded)
128
---
139

14-
# Link environment variables reference
15-
1610
> **Note:** Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](compose-file.md#links) for details.
1711
>
1812
> Environment variables will only be populated if you're using the [legacy version 1 Compose file format](compose-file.md#versioning).

‎compose/networking.md

-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: How Compose sets up networking between containers
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers, networking
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 21
95
title: Networking in Compose
106
---
117

12-
# Networking in Compose
13-
148
> **Note:** This document only applies if you're using [version 2 of the Compose file format](compose-file.md#versioning). Networking features are not supported for version 1 (legacy) Compose files.
159
1610
By default Compose sets up a single

‎compose/overview.md

-6
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Introduction and Overview of Compose
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: -99
95
title: Overview of Docker Compose
106
---
117

12-
# Overview of Docker Compose
13-
148
Compose is a tool for defining and running multi-container Docker applications.
159
With Compose, you use a Compose file to configure your application's services.
1610
Then, using a single command, you create and start all the services

‎compose/production.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Guide to using Docker Compose in production
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers, production
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 22
9-
title: Using Compose in Production
5+
title: Using Compose in production
106
---
117

12-
## Using Compose in production
13-
148
When you define your app with Compose in development, you can use this
159
definition to run your application in different environments such as CI,
1610
staging, and production.

‎compose/rails.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Getting started with Docker Compose and Rails
33
keywords:
44
- documentation, docs, docker, compose, orchestration, containers
5-
menu:
6-
main:
7-
parent: workw_compose
8-
weight: 5
9-
title: 'Quickstart: Compose and Rails'
5+
title: "Quickstart: Compose and Rails"
106
---
117

12-
## Quickstart: Docker Compose and Rails
13-
148
This Quickstart guide will show you how to use Docker Compose to set up and run a Rails/PostgreSQL app. Before starting, you'll need to have [Compose installed](install.md).
159

1610
### Define the project

‎compose/reference/build.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
---
2-
description: build
2+
description: docker-compose build
33
keywords:
44
- fig, composition, compose, docker, orchestration, cli, build
5-
menu:
6-
main:
7-
identifier: build.compose
8-
parent: smn_compose_cli
9-
title: build
5+
title: docker-compose build
106
---
117

12-
# build
13-
148
```
159
Usage: build [options] [SERVICE...]
1610

‎compose/reference/bundle.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Create a distributed application bundle from the Compose file.
33
keywords:
44
- fig, composition, compose, docker, orchestration, cli, bundle
5-
menu:
6-
main:
7-
identifier: bundle.compose
8-
parent: smn_compose_cli
9-
title: bundle
5+
title: docker-compose bundle
106
---
117

12-
# bundle
13-
148
```
159
Usage: bundle [options]
1610

‎compose/reference/config.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Config validates and view the compose file.
33
keywords:
44
- fig, composition, compose, docker, orchestration, cli, config
5-
menu:
6-
main:
7-
identifier: config.compose
8-
parent: smn_compose_cli
9-
title: config
5+
title: docker-compose config
106
---
117

12-
# config
13-
148
```:
159
Usage: config [options]
1610

‎compose/reference/create.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
description: Create creates containers for a service.
33
keywords:
44
- fig, composition, compose, docker, orchestration, cli, create
5-
menu:
6-
main:
7-
identifier: create.compose
8-
parent: smn_compose_cli
9-
title: create
5+
title: docker-compose create
106
---
117

12-
# create
13-
148
```
159
Creates containers for a service.
1610

0 commit comments

Comments
 (0)