Skip to content

Commit

Permalink
chore: fix heading levels
Browse files Browse the repository at this point in the history
Document headings incorrectly began at level 2.
Changed the first-level heading to h1 and adjusted subsections.

Signed-off-by: David Karlsson <[email protected]>
  • Loading branch information
dvdksn authored and ndeloof committed Nov 21, 2023
1 parent ec342b4 commit 478928e
Show file tree
Hide file tree
Showing 17 changed files with 393 additions and 369 deletions.
2 changes: 1 addition & 1 deletion 00-overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Compose file specification
# Compose file specification

The Compose file specification has been broken up into the following easy-to-navigate pages:

Expand Down
4 changes: 2 additions & 2 deletions 01-status.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Status of this document
# Status of this document

This document specifies the Compose file format used to define multi-containers applications. Distribution of this document is unlimited.

### Requirements and optional attributes
## Requirements and optional attributes

The Compose specification includes properties designed to target a local [OCI](https://opencontainers.org/) container runtime,
exposing Linux kernel specific configuration options, but also some Windows container specific properties. It is also designed for cloud platform features related to resource placement on a cluster, replicated application distribution, and scalability.
Expand Down
4 changes: 2 additions & 2 deletions 02-model.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## The Compose application model
# The Compose application model

The Compose Specification lets you define a platform-agnostic container based application. Such an application is designed as a set of containers which have to both run together with adequate shared resources and communication channels.

Expand All @@ -24,7 +24,7 @@ Compose offers a way for users to set a custom project name and override this na

Project names must contain only lowercase letters, decimal digits, dashes, and underscores, and must begin with a lowercase letter or decimal digit.

### Illustrative example
## Illustrative example

The following example illustrates the Compose Specification concepts outlined above. The example is non-normative.

Expand Down
2 changes: 1 addition & 1 deletion 03-compose-file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Compose file
# Compose file

The Compose file is a [YAML](http://yaml.org/) file defining:
- [Version](04-version-and-name.md) (Optional)
Expand Down
2 changes: 2 additions & 0 deletions 04-version-and-name.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Version and name top-level elements

## Version top-level element

The top-level `version` property is defined by the Compose Specification for backward compatibility. It is only informative.
Expand Down
Loading

0 comments on commit 478928e

Please sign in to comment.