*.md: update TOC and links

Some of the docs were not even linked to, and did not have a logic
outline for their grouping.

Signed-off-by: Vincent Batts <[email protected]>

Author: vbatts

README.md

@@ -7,12 +7,16 @@ Table of Contents
 
 - [Container Principles](principles.md)
 - [Filesystem Bundle](bundle.md)
-- [Container Configuration](config.md)
-  - [Linux Specific Configuration](config-linux.md)
+- Configuration
+  - [Container Configuration](config.md)
+  - [Container Configuration (Linux-specific)](config-linux.md)
+  - [Runtime Configuration](runtime-config.md)
+  - [Runtime Configuration (Linux-specific)](runtime-config-linux.md)
 - [Runtime and Lifecycle](runtime.md)
+  - [Linux Specific Runtime](runtime-linux.md)
 - [Implementations](implementations.md)
 
-## Use Cases
+# Use Cases
 
 To provide context for users the following section gives example use cases for each part of the spec.
 

bundle.md

@@ -1,4 +1,6 @@
-# Bundle Container Format
+# Bundle
+
+## Container Format
 
 This section defines a format for encoding a container as a *bundle* - a directory organized in a certain way, and containing all the necessary data and metadata for any compliant runtime to perform all standard operations against it.
 See also [OS X application bundles](http://en.wikipedia.org/wiki/Bundle_%28OS_X%29) for a similar use of the term *bundle*.
@@ -14,15 +16,18 @@ A standard container bundle is made of the following 3 parts:
 - One or more content directories
 - A configuration file
 
-# Directory layout
+## Directory layout
 
 A Standard Container bundle is a directory containing all the content needed to load and run a container.
 This includes two configuration files `config.json` and `runtime.json`, and a rootfs directory.
 The `config.json` file contains settings that are host independent and application specific such as security permissions, environment variables and arguments.
 The `runtime.json` file contains settings that are host specific such as memory limits, local device access and mount points.
 The goal is that the bundle can be moved as a unit to another machine and run the same application if `runtime.json` is removed or reconfigured.
 
-The syntax and semantics for `config.json` are described in [this specification](config.md).
+Configuration file syntax and semantics:
+
+* [`config.json`](config.md) (immutable, host independent configuration)
+* [`runtime.json`](runtime-config.md) (mutable, host dependent configuration)
 
 A single `rootfs` directory MUST be in the same directory as the `config.json`.
 The names of the directories may be arbitrary, but users should consider using conventional names as in the example below.

code-of-conduct.md

@@ -2,7 +2,6 @@
 
 Behave as a community member, follow the code of conduct.
 
-
 ## Code of Conduct
 
 The OpenContainers community is made up of a mixture of professionals and volunteers from all over the world.
@@ -36,4 +35,3 @@ By adopting this Code of Conduct, project maintainers commit themselves to fairl
 Thanks to the [Fedora Code of Conduct](https://getfedora.org/code-of-conduct) and [Contributor Covenant](http://contributor-covenant.org) for inspiration and ideas.
 
 Portions of this Code of Conduct are adapted from the Contributor Covenant, version 1.2.0, available at http://contributor-covenant.org/version/1/2/0/
-

config-linux.md

@@ -1,4 +1,4 @@
-# Linux-specific configuration
+# Linux-specific Container Configuration
 
 The Linux container specification uses various kernel features like namespaces, cgroups, capabilities, LSM, and file system jails to fulfill the spec.
 Additional information is needed for Linux over the [default spec configuration](config.md) in order to configure these various kernel features.

config.md

@@ -1,4 +1,4 @@
-# Configuration file
+# Container Configuration file
 
 The container's top-level directory MUST contain a configuration file called `config.json`.
 For now the canonical schema is defined in [config.go](config.go) and [config_linux.go](config_linux.go), but this will be moved to a formal JSON schema over time.

runtime-config-linux.md

@@ -1,3 +1,5 @@
+# Linux-specific Runtime Configuration
+
 ## Namespaces
 
 A namespace wraps a global system resource in an abstraction that makes it appear to the processes within the namespace that they have their own isolated instance of the global resource.

runtime-config.md

@@ -1,3 +1,5 @@
+# Runtime Configuration
+
 ## Mount Configuration
 
 Additional filesystems can be declared as "mounts", specified in the *mounts* object.

runtime-linux.md

@@ -1,3 +1,5 @@
+# Linux Runtime
+
 ## File descriptors
 By default, only the `stdin`, `stdout` and `stderr` file descriptors are kept open for the application by the runtime.