Skip to content

Commit

Permalink
Converges titles to imperative-form, front-matter based, and sentence…
Browse files Browse the repository at this point in the history
…-case (docker#438)

Multiple title fixes, consistency fixes, convergence into metadata-based titles.
  • Loading branch information
johndmulhausen authored Nov 4, 2016
1 parent 9bf89d4 commit 558314b
Show file tree
Hide file tree
Showing 672 changed files with 2,091 additions and 5,677 deletions.
1 change: 1 addition & 0 deletions _layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@
</div>
<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 %} >
<section class="section" id="DocumentationText">
{% if page.title %}<h1>{{ page.title }}</h1>{% endif %}
{{ content }}
{% if page.noratings != true %}
<div style="text-align: center; margin-top: 50px">
Expand Down
8 changes: 0 additions & 8 deletions apidocs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,9 @@
description: Learn how to use DTR APIs.
keywords:
- docker, registry, DTR, APIs
menu:
main:
identifier: smn_dtrapi
parent: workw_dtr
weight: "100"
title: DTR APIs
type: _default
---

# DTR APIs

This section includes the following topics:

* [API overview](overview.md)
10 changes: 1 addition & 9 deletions apidocs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,9 @@
description: Learn how to use DTR APIs.
keywords:
- docker, registry, DTR, APIs
menu:
main:
identifier: dtr_api_overview
parent: smn_dtrapi
weight: 0
title: Overview
type: _default
title: API overview
---

# API Overview

Docker Trusted Registry has an experimental API that you can use to manage
DTR repositories, permissions, and settings.

Expand Down
10 changes: 2 additions & 8 deletions compose/bundles.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
---
advisory: experimental
description: Description of Docker and Compose's experimental support for application
bundles
description: Description of Docker and Compose's experimental support for application bundles
keywords:
- documentation, docs, docker, compose, bundles, stacks
menu:
main:
parent: workw_compose
title: Docker Stacks and Distributed Application Bundles
title: Docker stacks and distributed application bundles (experimental)
---

# Docker Stacks and Distributed Application Bundles (experimental)

> **Note**: This is a copy of the [Docker Stacks and Distributed Application
> Bundles](https://github.com/docker/docker/blob/v1.12.0-rc4/experimental/docker-stacks-and-bundles.md)
> document in the [docker/docker repo](https://github.com/docker/docker).
Expand Down
8 changes: 1 addition & 7 deletions compose/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
menu:
main:
parent: workw_compose
weight: 88
title: Command-line Completion
title: Command-line completion
---

# Command-line Completion

Compose comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion)
for the bash and zsh shell.

Expand Down
8 changes: 1 addition & 7 deletions compose/compose-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,9 @@ aliases:
description: Compose file reference
keywords:
- fig, composition, compose, docker
menu:
main:
parent: workw_compose
weight: 70
title: Compose File Reference
title: Compose file reference
---

# Compose file reference

The Compose file is a [YAML](http://yaml.org/) file defining
[services](compose-file.md#service-configuration-reference),
[networks](compose-file.md#network-configuration-reference) and
Expand Down
8 changes: 1 addition & 7 deletions compose/django.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Getting started with Docker Compose and Django
keywords:
- documentation, docs, docker, compose, orchestration, containers
menu:
main:
parent: workw_compose
weight: 4
title: 'Quickstart: Compose and Django'
title: "Quickstart: Compose and Django"
---

# Quickstart: Docker Compose and Django

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
[Compose installed](install.md).

Expand Down
10 changes: 2 additions & 8 deletions compose/env-file.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
---
description: Declaring default environment variables in file
description: Declare default environment variables in a file
keywords:
- fig, composition, compose, docker, orchestration, environment, env file
menu:
main:
parent: workw_compose
weight: 10
title: Environment file
title: Declare default environment variables in file
---

# Environment file

Compose supports declaring default environment variables in an environment
file named `.env` placed in the folder `docker-compose` command is executed from
*(current working directory)*.
Expand Down
6 changes: 0 additions & 6 deletions compose/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: How to set, use and manage environment variables in Compose
keywords:
- fig, composition, compose, docker, orchestration, environment, variables, env file
menu:
main:
parent: workw_compose
weight: 10
title: Environment variables in Compose
---

# Environment variables in Compose

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.


Expand Down
11 changes: 2 additions & 9 deletions compose/extends.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
---
description: How to use Docker Compose's extends keyword to share configuration between
files and projects
description: How to use Docker Compose's extends keyword to share configuration between files and projects
keywords:
- fig, composition, compose, docker, orchestration, documentation, docs
menu:
main:
parent: workw_compose
weight: 20
title: Extending Services in Compose
title: Share Compose configurations between files and projects
---

# Extending services and Compose files

Compose supports two methods of sharing common configuration:

1. Extending an entire Compose file by
Expand Down
9 changes: 1 addition & 8 deletions compose/faq.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
---
description: Docker Compose FAQ
keywords: documentation, docs, docker, compose, faq
menu:
main:
identifier: faq.compose
parent: workw_compose
weight: 90
title: Frequently Asked Questions
title: Frequently asked questions
---

# Frequently asked questions

If you don’t see your question here, feel free to drop by `#docker-compose` on
freenode IRC and ask the community.

Expand Down
10 changes: 2 additions & 8 deletions compose/gettingstarted.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
---
description: Getting started with Docker Compose
description: Get started with Docker Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
menu:
main:
parent: workw_compose
weight: -85
title: Getting Started
title: Get started with Docker Compose
---

# Getting Started

On this page you build a simple Python web application running on Docker Compose. The
application uses the Flask framework and increments a value in Redis. While the
sample uses Python, the concepts demonstrated here should be understandable even
Expand Down
6 changes: 0 additions & 6 deletions compose/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Introduction and Overview of Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
menu:
main:
identifier: workw_compose
weight: -70
title: Docker Compose
---

# Docker Compose

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

- [Compose Overview](overview.md)
Expand Down
8 changes: 1 addition & 7 deletions compose/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: How to install Docker Compose
keywords:
- compose, orchestration, install, installation, docker, documentation
menu:
main:
parent: workw_compose
weight: -90
title: Install Compose
title: Install Docker Compose
---

# Install Docker Compose

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

To install Compose, do the following:
Expand Down
8 changes: 1 addition & 7 deletions compose/link-env-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,9 @@ aliases:
description: Compose CLI reference
keywords:
- fig, composition, compose, docker, orchestration, cli, reference
menu:
main:
parent: workw_compose
weight: 89
title: Link Environment Variables
title: Link environment variables (superseded)
---

# Link environment variables reference

> **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.
>
> Environment variables will only be populated if you're using the [legacy version 1 Compose file format](compose-file.md#versioning).
Expand Down
6 changes: 0 additions & 6 deletions compose/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: How Compose sets up networking between containers
keywords:
- documentation, docs, docker, compose, orchestration, containers, networking
menu:
main:
parent: workw_compose
weight: 21
title: Networking in Compose
---

# Networking in Compose

> **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.
By default Compose sets up a single
Expand Down
6 changes: 0 additions & 6 deletions compose/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Introduction and Overview of Compose
keywords:
- documentation, docs, docker, compose, orchestration, containers
menu:
main:
parent: workw_compose
weight: -99
title: Overview of Docker Compose
---

# Overview of Docker Compose

Compose is a tool for defining and running multi-container Docker applications.
With Compose, you use a Compose file to configure your application's services.
Then, using a single command, you create and start all the services
Expand Down
8 changes: 1 addition & 7 deletions compose/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Guide to using Docker Compose in production
keywords:
- documentation, docs, docker, compose, orchestration, containers, production
menu:
main:
parent: workw_compose
weight: 22
title: Using Compose in Production
title: Using Compose in production
---

## Using Compose in production

When you define your app with Compose in development, you can use this
definition to run your application in different environments such as CI,
staging, and production.
Expand Down
8 changes: 1 addition & 7 deletions compose/rails.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Getting started with Docker Compose and Rails
keywords:
- documentation, docs, docker, compose, orchestration, containers
menu:
main:
parent: workw_compose
weight: 5
title: 'Quickstart: Compose and Rails'
title: "Quickstart: Compose and Rails"
---

## Quickstart: Docker Compose and Rails

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).

### Define the project
Expand Down
10 changes: 2 additions & 8 deletions compose/reference/build.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
---
description: build
description: docker-compose build
keywords:
- fig, composition, compose, docker, orchestration, cli, build
menu:
main:
identifier: build.compose
parent: smn_compose_cli
title: build
title: docker-compose build
---

# build

```
Usage: build [options] [SERVICE...]
Expand Down
8 changes: 1 addition & 7 deletions compose/reference/bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Create a distributed application bundle from the Compose file.
keywords:
- fig, composition, compose, docker, orchestration, cli, bundle
menu:
main:
identifier: bundle.compose
parent: smn_compose_cli
title: bundle
title: docker-compose bundle
---

# bundle

```
Usage: bundle [options]
Expand Down
8 changes: 1 addition & 7 deletions compose/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Config validates and view the compose file.
keywords:
- fig, composition, compose, docker, orchestration, cli, config
menu:
main:
identifier: config.compose
parent: smn_compose_cli
title: config
title: docker-compose config
---

# config

```:
Usage: config [options]
Expand Down
8 changes: 1 addition & 7 deletions compose/reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,9 @@
description: Create creates containers for a service.
keywords:
- fig, composition, compose, docker, orchestration, cli, create
menu:
main:
identifier: create.compose
parent: smn_compose_cli
title: create
title: docker-compose create
---

# create

```
Creates containers for a service.
Expand Down
Loading

0 comments on commit 558314b

Please sign in to comment.