From 9288db25eacccf1199ad1db9a0d275c80289901d Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Tue, 27 Feb 2018 11:15:20 -0800 Subject: [PATCH] Add autogenerated Table of Contents See https://github.com/docker-library/official-images/pull/4061 (the script which generated this, and which will update it). --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 73aaa65d5..46018e0f6 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,33 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/ - [Automated `update.sh` and `push.sh`: ![build status badge](https://doi-janky.infosiftr.net/job/docs/job/update/badge/icon)](https://doi-janky.infosiftr.net/job/docs/job/update/) +## Table of Contents + + + +1. [What is this?](#what-is-this) + 1. [Table of Contents](#table-of-contents) +2. [How do I add a new image's docs](#how-do-i-add-a-new-images-docs) +3. [How do I update an image's docs](#how-do-i-update-an-images-docs) +4. [What are all these files?](#what-are-all-these-files) + 1. [`update.sh`](#updatesh) + 2. [`generate-repo-stub-readme.sh`](#generate-repo-stub-readmesh) + 3. [`push.pl`](#pushpl) + 4. [`.template-helpers/generate-dockerfile-links-partial.sh`](#template-helpersgenerate-dockerfile-links-partialsh) + 5. [`.template-helpers/template.md` and `.template-helpers/user-feedback.md`](#template-helperstemplatemd-and-template-helpersuser-feedbackmd) + 6. [folder ``](#folder-image-name) + 7. [`/README.md`](#image-name-readmemd) + 8. [`/content.md`](#image-name-contentmd) + 9. [`/README-short.txt`](#image-name-readme-shorttxt) + 10. [`/logo.png`](#image-name-logopng) + 11. [`/license.md`](#image-name-licensemd) + 12. [`/maintainer.md`](#image-name-maintainermd) + 13. [`/github-repo`](#image-name-github-repo) + 14. [`/user-feedback.md`](#image-name-user-feedbackmd) +5. [Issues and Contributing](#issues-and-contributing) + + + # How do I add a new image's docs - create a folder for my image: `mkdir myimage`