|
@@ -9,6 +9,33 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
|
|
|
- [Automated `update.sh` and `push.sh`:
|
|
- [Automated `update.sh` and `push.sh`:
|
|
|
](https://doi-janky.infosiftr.net/job/docs/job/update/)
|
|
](https://doi-janky.infosiftr.net/job/docs/job/update/)
|
|
|
|
|
|
|
|
|
|
+## Table of Contents
|
|
|
|
|
+
|
|
|
|
|
+<!-- AUTOGENERATED TOC -->
|
|
|
|
|
+
|
|
|
|
|
+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 `<image name>`](#folder-image-name)
|
|
|
|
|
+ 7. [`<image name>/README.md`](#image-name-readmemd)
|
|
|
|
|
+ 8. [`<image name>/content.md`](#image-name-contentmd)
|
|
|
|
|
+ 9. [`<image name>/README-short.txt`](#image-name-readme-shorttxt)
|
|
|
|
|
+ 10. [`<image name>/logo.png`](#image-name-logopng)
|
|
|
|
|
+ 11. [`<image name>/license.md`](#image-name-licensemd)
|
|
|
|
|
+ 12. [`<image name>/maintainer.md`](#image-name-maintainermd)
|
|
|
|
|
+ 13. [`<image name>/github-repo`](#image-name-github-repo)
|
|
|
|
|
+ 14. [`<image name>/user-feedback.md`](#image-name-user-feedbackmd)
|
|
|
|
|
+5. [Issues and Contributing](#issues-and-contributing)
|
|
|
|
|
+
|
|
|
|
|
+<!-- AUTOGENERATED TOC -->
|
|
|
|
|
+
|
|
|
# How do I add a new image's docs
|
|
# How do I add a new image's docs
|
|
|
|
|
|
|
|
- create a folder for my image: `mkdir myimage`
|
|
- create a folder for my image: `mkdir myimage`
|