Browse Source

Move TOC Out Of Its Misery

~ Remove the suprising effect that the README's table of contents has when encountered in the middle of reading.
Jonas Thelemann 6 years ago
parent
commit
fc1f61094f
1 changed files with 35 additions and 35 deletions
  1. 35 35
      README.md

+ 35 - 35
README.md

@@ -2,6 +2,41 @@
 
 [![Build Status](https://travis-ci.org/docker-library/official-images.svg?branch=master)](https://travis-ci.org/docker-library/official-images)
 
+## Table of Contents
+
+<!-- AUTOGENERATED TOC -->
+
+1.	[Docker Official Images](#docker-official-images)
+	1.	[Table of Contents](#table-of-contents)
+	2.	[What are "Official Images"?](#what-are-official-images)
+	3.	[What do you mean by "Official"?](#what-do-you-mean-by-official)
+	4.	[Architectures other than amd64?](#architectures-other-than-amd64)
+	5.	[More FAQs?](#more-faqs)
+	6.	[Contributing to the standard library](#contributing-to-the-standard-library)
+		1.	[Review Guidelines](#review-guidelines)
+			1.	[Maintainership](#maintainership)
+			2.	[Repeatability](#repeatability)
+			3.	[Consistency](#consistency)
+			4.	[Clarity](#clarity)
+			5.	[init](#init)
+			6.	[Cacheability](#cacheability)
+			7.	[Security](#security)
+				1.	[Image Build](#image-build)
+				2.	[Runtime Configuration](#runtime-configuration)
+				3.	[Security Releases](#security-releases)
+			8.	[Multiple Architectures](#multiple-architectures)
+		2.	[Commitment](#commitment)
+	7.	[Library definition files](#library-definition-files)
+		1.	[Filenames](#filenames)
+		2.	[Tags and aliases](#tags-and-aliases)
+		3.	[Instruction format](#instruction-format)
+		4.	[Creating a new repository](#creating-a-new-repository)
+		5.	[Adding a new tag in an existing repository (that you're the maintainer of)](#adding-a-new-tag-in-an-existing-repository-that-youre-the-maintainer-of)
+		6.	[Change to a tag in an existing repository (that you're the maintainer of)](#change-to-a-tag-in-an-existing-repository-that-youre-the-maintainer-of)
+	8.	[Bashbrew](#bashbrew)
+
+<!-- AUTOGENERATED TOC -->
+
 ## What are "Official Images"?
 
 See [Docker's documentation](https://docs.docker.com/docker-hub/official_repos/) for a good high-level overview of the program.
@@ -52,41 +87,6 @@ Be sure to familiarize yourself with [Official Repositories on Docker Hub](https
 
 Also, the Hub descriptions for these images are currently stored separately in the [`docker-library/docs` repository](https://github.com/docker-library/docs), whose [`README.md` file](https://github.com/docker-library/docs/blob/master/README.md) explains more about how it's structured and how to contribute to it. Please be prepared to submit a PR there as well, pending acceptance of your image here.
 
-### Table of Contents
-
-<!-- AUTOGENERATED TOC -->
-
-1.	[Docker Official Images](#docker-official-images)
-	1.	[What are "Official Images"?](#what-are-official-images)
-	2.	[What do you mean by "Official"?](#what-do-you-mean-by-official)
-	3.	[Architectures other than amd64?](#architectures-other-than-amd64)
-	4.	[More FAQs?](#more-faqs)
-	5.	[Contributing to the standard library](#contributing-to-the-standard-library)
-		1.	[Table of Contents](#table-of-contents)
-		2.	[Review Guidelines](#review-guidelines)
-			1.	[Maintainership](#maintainership)
-			2.	[Repeatability](#repeatability)
-			3.	[Consistency](#consistency)
-			4.	[Clarity](#clarity)
-			5.	[init](#init)
-			6.	[Cacheability](#cacheability)
-			7.	[Security](#security)
-				1.	[Image Build](#image-build)
-				2.	[Runtime Configuration](#runtime-configuration)
-				3.	[Security Releases](#security-releases)
-			8.	[Multiple Architectures](#multiple-architectures)
-		3.	[Commitment](#commitment)
-	6.	[Library definition files](#library-definition-files)
-		1.	[Filenames](#filenames)
-		2.	[Tags and aliases](#tags-and-aliases)
-		3.	[Instruction format](#instruction-format)
-		4.	[Creating a new repository](#creating-a-new-repository)
-		5.	[Adding a new tag in an existing repository (that you're the maintainer of)](#adding-a-new-tag-in-an-existing-repository-that-youre-the-maintainer-of)
-		6.	[Change to a tag in an existing repository (that you're the maintainer of)](#change-to-a-tag-in-an-existing-repository-that-youre-the-maintainer-of)
-	7.	[Bashbrew](#bashbrew)
-
-<!-- AUTOGENERATED TOC -->
-
 ### Review Guidelines
 
 Because the official images are intended to be learning tools for those new to Docker as well as the base images for advanced users to build their production releases, we review each proposed `Dockerfile` to ensure that it meets a minimum standard for quality and maintainability. While some of that standard is hard to define (due to subjectivity), as much as possible is defined here, while also adhering to the "Best Practices" where appropriate.