Syncup with remote

.ci/check-pr-no-readme.sh

@@ -4,7 +4,8 @@ set -Eeuo pipefail
 cd "$(dirname "$(readlink -f "$BASH_SOURCE")")/.."
 
 git fetch -q https://github.com/docker-library/docs.git master
-if [ -n "$(git diff --numstat FETCH_HEAD...HEAD -- '*/README.md')" ]; then
+numstat="$(git diff --numstat FETCH_HEAD...HEAD -- '*/README.md')"
+if [ -n "$numstat" ]; then
 	echo >&2 'Error: at least one repo README.md has changed'
 	echo >&2 'These files are autogenerated, so it is unnecessary to modify them'
 	echo >&2 'Please update content.md and docker-library-bot will take care of README.md'

.github/workflows/ci.yml

@@ -39,5 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - run: .ci/check-pr-no-readme.sh
     if: ${{ github.event_name == 'pull_request' }}

.template-helpers/generate-dockerfile-links-partial.tmpl

@@ -21,22 +21,24 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
 	{{- $froms := $.ArchDockerFroms $arch $e -}}
 
 	{{- $gitRepo := $e.ArchGitRepo $arch -}}
+	{{- $gitCommit := $e.ArchGitCommit $arch -}}
+	{{- $dir := .ArchDirectory $arch -}}
+	{{- $dockerfile := .ArchFile $arch -}}
+	{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
 	{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
-	{{- $isGitHub := hasPrefix "https://github.com/" $repoUrlBase -}}
+	{{- $url := hasPrefix "https://github.com/" $repoUrlBase | ternary (join "/" $repoUrlBase "blob" $gitCommit $dockerfilePath) "" -}}
+	{{- /* handle https://gitlab.../.../... style URLs (by reasonably assuming they're a gitlab instance) */ -}}
+	{{- $url = $url | ternary $url (hasPrefix "https://gitlab." $repoUrlBase | ternary (join "/" $repoUrlBase "-/blob" $gitCommit $dockerfilePath) "") -}}
+	{{- /* TODO decide what to do (if anything) about other non-GitHub repos with respect to URL */ -}}
 
 	{{- if $i -}}
 		{{- "\n" -}}
 	{{- end -}}
 
 	- {{- "\t" -}}
-	{{- if $isGitHub -}} [ {{- end -}}
-	{{- $dir := .ArchDirectory $arch -}}
-	{{- $dockerfile := .ArchFile $arch -}}
-	{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
+	{{- if $url -}} [ {{- end -}}
 	` {{- $e.Tags | join "`, `" -}} `
-	{{- $gitCommit := $e.ArchGitCommit $arch -}}
-	{{- if $isGitHub -}} ]( {{- $repoUrlBase -}} /blob/ {{- $gitCommit -}} / {{- $dockerfilePath -}} ) {{- end -}}
-	{{- /* TODO decide what to do (if anything) about non-GitHub repos with respect to URL */ -}}
+	{{- if $url -}} ]( {{- $url -}} ) {{- end -}}
 {{- end -}}
 {{- "\n\n" -}}
 
@@ -58,18 +60,20 @@ This template defines the "Supported tags and Dockerfile links" portion of an im
 				{{- $froms := $.ArchDockerFroms $arch $e -}}
 
 				{{- $gitRepo := $e.ArchGitRepo $arch -}}
-				{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
-				{{- $isGitHub := hasPrefix "https://github.com/" $repoUrlBase -}}
-
-				{{- "\t-\t" -}}
-				{{- if $isGitHub -}} [ {{- end -}}
+				{{- $gitCommit := $e.ArchGitCommit $arch -}}
 				{{- $dir := .ArchDirectory $arch -}}
 				{{- $dockerfile := .ArchFile $arch -}}
 				{{- $dockerfilePath := eq $dir "." | ternary $dockerfile (join "/" $dir $dockerfile) -}}
+				{{- $repoUrlBase := $gitRepo | replace "git://" "https://" | trimSuffixes ".git" -}}
+				{{- $url := hasPrefix "https://github.com/" $repoUrlBase | ternary (join "/" $repoUrlBase "blob" $gitCommit $dockerfilePath) "" -}}
+				{{- /* handle https://gitlab.../.../... style URLs (by reasonably assuming they're a gitlab instance) */ -}}
+				{{- $url = $url | ternary $url (hasPrefix "https://gitlab." $repoUrlBase | ternary (join "/" $repoUrlBase "-/blob" $gitCommit $dockerfilePath) "") -}}
+				{{- /* TODO decide what to do (if anything) about other non-GitHub repos with respect to URL */ -}}
+
+				{{- "\t-\t" -}}
+				{{- if $url -}} [ {{- end -}}
 				` {{- $e.Tags | first -}} `
-				{{- $gitCommit := $e.ArchGitCommit $arch -}}
-				{{- if $isGitHub -}} ]( {{- $repoUrlBase -}} /blob/ {{- $gitCommit -}} / {{- $dockerfilePath -}} ) {{- end -}}
-				{{- /* TODO decide what to do (if anything) about non-GitHub repos with respect to URL */ -}}
+				{{- if $url -}} ]( {{- $url -}} ) {{- end -}}
 
 				{{- "\n" -}}
 			{{- end -}}

.template-helpers/get-help.md

@@ -1 +1 @@
-[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](http://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
+[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)

.template-helpers/template.md

@@ -23,7 +23,7 @@
 	(image metadata, transfer size, etc)
 
 -	**Image updates**:  
-	[official-images PRs with label `library/%%REPO%%`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2F%%REPO%%)  
+	[official-images repo's `library/%%REPO%%` label](https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2F%%REPO%%)  
 	[official-images repo's `library/%%REPO%%` file](https://github.com/docker-library/official-images/blob/master/library/%%REPO%%) ([history](https://github.com/docker-library/official-images/commits/master/library/%%REPO%%))
 
 -	**Source of this description**:  

.template-helpers/variant-alpine.md

@@ -1,7 +1,7 @@
 ## `%%IMAGE%%:<version>-alpine`
 
-This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
+This image is based on the popular [Alpine Linux project](https://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
 
-This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
+This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use [musl libc](https://musl.libc.org) instead of [glibc and friends](https://www.etalabs.net/compare_libcs.html), so software will often run into issues depending on the depth of their libc requirements/assumptions. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
 
 To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).

README.md

@@ -2,7 +2,7 @@
 
 This repository contains the image documentation for each of the official images. See [docker-library/official-images](https://github.com/docker-library/official-images) for more information about the program in general.
 
-All Markdown files here are run through [tianon's fork of `markdownfmt`](https://github.com/tianon/markdownfmt) (only forked to add some smaller-diff preference and minor DockerHub-compatibility changes), and verified as formatted correctly via GitHub Actions.
+All Markdown files here are run through [tianon's fork of `markdownfmt`](https://github.com/tianon/markdownfmt), and verified as formatted correctly via GitHub Actions.
 
 -	[![GitHub CI status badge](https://img.shields.io/github/workflow/status/docker-library/docs/GitHub%20CI/master?label=GitHub%20CI)](https://github.com/docker-library/docs/actions?query=workflow%3A%22GitHub+CI%22+branch%3Amaster)
 -	[![library update.sh status badge](https://img.shields.io/jenkins/s/https/doi-janky.infosiftr.net/job/docs/job/library.svg?label=Automated%20library%20update.sh)](https://doi-janky.infosiftr.net/job/docs/job/library/)
@@ -22,27 +22,34 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
 
 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)
+2.	[How do I update an image's docs](#how-do-i-update-an-images-docs)
+3.	[How do I add a new image's docs](#how-do-i-add-a-new-images-docs)
+4.	[Files related to an image's docs](#files-related-to-an-images-docs)
+	1.	[folder `<image name>`](#folder-image-name)
+	2.	[`README.md`](#readmemd)
+	3.	[`content.md`](#contentmd)
+	4.	[`README-short.txt`](#readme-shorttxt)
+	5.	[`logo.png`](#logopng)
+	6.	[`license.md`](#licensemd)
+	7.	[`maintainer.md`](#maintainermd)
+	8.	[`github-repo`](#github-repo)
+	9.	[`user-feedback.md`](#user-feedbackmd)
+5.	[Files for main Docs repo](#files-for-main-docs-repo)
 	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-namereadmemd)
-	8.	[`<image name>/content.md`](#image-namecontentmd)
-	9.	[`<image name>/README-short.txt`](#image-namereadme-shorttxt)
-	10.	[`<image name>/logo.png`](#image-namelogopng)
-	11.	[`<image name>/license.md`](#image-namelicensemd)
-	12.	[`<image name>/maintainer.md`](#image-namemaintainermd)
-	13.	[`<image name>/github-repo`](#image-namegithub-repo)
-	14.	[`<image name>/user-feedback.md`](#image-nameuser-feedbackmd)
-5.	[Issues and Contributing](#issues-and-contributing)
+6.	[Issues and Contributing](#issues-and-contributing)
 
 <!-- AUTOGENERATED TOC -->
 
+# How do I update an image's docs
+
+Edit the `content.md` for an image; not the `README.md` as it's auto-generated from the contents of the other files in that repo. To see the changes to the `README.md`, run `./update.sh myimage` from the repo root, but do not add the `README.md` changes to your pull request. See also `markdownfmt.sh` point [below](#how-do-i-add-a-new-images-docs).
+
+After opening your Pull Request the changes will be checked by an automated `markdownfmt.sh` before it can be merged. A common issue is incorrect spacing such as with two lines missing an empty line between them (double-spaced).
+
 # How do I add a new image's docs
 
 -	create a folder for my image: `mkdir myimage`
@@ -59,43 +66,17 @@ Optionally:
 -	run `./update.sh myimage` to generate `myimage/README.md` for manual review of the generated copy.  
 	**Note:** do not actually commit the `README.md` file; it is automatically generated/committed before being uploaded to Docker Hub.
 
-# How do I update an image's docs
-
-To update `README.md` for a specific image do not edit `README.md` directly. Please edit `content.md` or another appropriate file within the folder. To see the changes, run `./update.sh myimage` from the repo root, but do not add the `README.md` changes to your pull request. See also `markdownfmt.sh` point [above](#how-do-i-add-a-new-images-docs).
-
-# What are all these files?
-
-## `update.sh`
-
-This is the main script used to generate the `README.md` files for each image. The generated file is committed along with the files used to generate it (see below on what customizations are available). Accepted arguments are which image(s) you want to update or no arguments to update all of them.
-
-This script assumes [`bashbrew`](https://github.com/docker-library/official-images/tree/81e90ca8dcec892ade7eb348cba5a4a5d6851e17/bashbrew) is in your `PATH` (for scraping relevant tag information from the library manifest file for each repository).
-
-## `generate-repo-stub-readme.sh`
-
-This is used to generate a simple `README.md` to put in the image's repo. Argument is the name of the image, like `golang` and it then outputs the readme to standard out.
-
-## `push.pl`
-
-This is used by us to push the actual content of the READMEs to the Docker Hub as special access is required to modify the Hub description contents.
-
-## `.template-helpers/generate-dockerfile-links-partial.sh`
-
-This script is used by `update.sh` to create the "Supported tags and respective `Dockerfile` links" section of each generated `README.md` from the information in the [official-images `library/` manifests](https://github.com/docker-library/official-images/tree/master/library).
-
-## `.template-helpers/template.md` and `.template-helpers/user-feedback.md`
-
-These files are the templates used in building the `<image name>/README.md` file, in combination with the individual image's files.
+# Files related to an image's docs
 
 ## folder `<image name>`
 
 This is where all the partial and generated files for a given image reside, (ex: `golang/`).
 
-## `<image name>/README.md`
+## `README.md`
 
 This file is generated using `update.sh`.
 
-## `<image name>/content.md`
+## `content.md`
 
 This file contains the main content of your image's long description. The basic parts you should have are a "What Is" section and a "How To" section. See the doc on [Official Repos](https://docs.docker.com/docker-hub/official_repos/#a-long-description) for more information on long description. The issues and contribution section is generated by the script but can be overridden. The following is a basic layout:
 
@@ -112,40 +93,64 @@ This file contains the main content of your image's long description. The basic
 // make use of subsections as necessary
 ```
 
-## `<image name>/README-short.txt`
+## `README-short.txt`
 
 This is the short description for the docker hub, limited to 100 characters in a single line.
 
 > Go (golang) is a general purpose, higher-level, imperative programming language.
 
-## `<image name>/logo.png`
+## `logo.png`
 
 Logo for the contained software. While there are not hard rules on formatting, most existing logos are square or landscape and stay within a few hundred pixels of width.
 
-## `<image name>/license.md`
+## `license.md`
 
 This file should contain a link to the license for the main software in the image. Here is an example for `golang`:
 
 ```markdown
 View [license information](http://golang.org/LICENSE) for the software contained in this image.
 ```
 
-## `<image name>/maintainer.md`
+## `maintainer.md`
 
 This file should contain a link to the maintainers of the Dockerfile.
 
-## `<image name>/github-repo`
+## `github-repo`
 
 This file should contain the URL to the GitHub repository for the Dockerfiles that become the images. The file should be in a single line ending in a newline with no extraneous whitespace. Only one GitHub repo per image repository is supported. It is used in generating links. Here is an example for `golang`:
 
 ```text
 https://github.com/docker-library/golang
 ```
 
-## `<image name>/user-feedback.md`
+## `user-feedback.md`
 
 This file is an optional override of the default `user-feedback.md` for those repositories with different issue and contributing policies.
 
+# Files for main Docs repo
+
+## `update.sh`
+
+This is the main script used to generate the `README.md` files for each image. The generated file is committed along with the files used to generate it (see below on what customizations are available). Accepted arguments are which image(s) you want to update or no arguments to update all of them.
+
+This script assumes [`bashbrew`](https://github.com/docker-library/official-images/tree/81e90ca8dcec892ade7eb348cba5a4a5d6851e17/bashbrew) is in your `PATH` (for scraping relevant tag information from the library manifest file for each repository).
+
+## `generate-repo-stub-readme.sh`
+
+This is used to generate a simple `README.md` to put in the image's repo. Argument is the name of the image, like `golang` and it then outputs the readme to standard out.
+
+## `push.pl`
+
+This is used by us to push the actual content of the READMEs to the Docker Hub as special access is required to modify the Hub description contents.
+
+## `.template-helpers/generate-dockerfile-links-partial.sh`
+
+This script is used by `update.sh` to create the "Supported tags and respective `Dockerfile` links" section of each generated `README.md` from the information in the [official-images `library/` manifests](https://github.com/docker-library/official-images/tree/master/library).
+
+## `.template-helpers/template.md` and `.template-helpers/user-feedback.md`
+
+These files are the templates used in building the `<image name>/README.md` file, in combination with the individual image's files.
+
 # Issues and Contributing
 
 If you would like to make a new Official Image, be sure to follow the [guidelines](https://docs.docker.com/docker-hub/official_repos/).

adminer/README.md

@@ -20,12 +20,12 @@ WARNING:
 	[Tim Düsterhus (of the Docker Community)](https://github.com/TimWolla/docker-adminer)
 
 -	**Where to get help**:  
-	[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](http://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
+	[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
 
 # Supported tags and respective `Dockerfile` links
 
--	[`4.7.7-standalone`, `4.7-standalone`, `4-standalone`, `standalone`, `4.7.7`, `4.7`, `4`, `latest`](https://github.com/TimWolla/docker-adminer/blob/18344428b4b12907f82ab8c03e865094d1ae0663/4/Dockerfile)
--	[`4.7.7-fastcgi`, `4.7-fastcgi`, `4-fastcgi`, `fastcgi`](https://github.com/TimWolla/docker-adminer/blob/18344428b4b12907f82ab8c03e865094d1ae0663/4/fastcgi/Dockerfile)
+-	[`4.8.0-standalone`, `4-standalone`, `standalone`, `4.8.0`, `4`, `latest`](https://github.com/TimWolla/docker-adminer/blob/40a2516bf4f95dc76a839b8b76e4a5eae2378e67/4/Dockerfile)
+-	[`4.8.0-fastcgi`, `4-fastcgi`, `fastcgi`](https://github.com/TimWolla/docker-adminer/blob/40a2516bf4f95dc76a839b8b76e4a5eae2378e67/4/fastcgi/Dockerfile)
 
 # Quick reference (cont.)
 
@@ -40,7 +40,7 @@ WARNING:
 	(image metadata, transfer size, etc)
 
 -	**Image updates**:  
-	[official-images PRs with label `library/adminer`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fadminer)  
+	[official-images repo's `library/adminer` label](https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fadminer)  
 	[official-images repo's `library/adminer` file](https://github.com/docker-library/official-images/blob/master/library/adminer) ([history](https://github.com/docker-library/official-images/commits/master/library/adminer))
 
 -	**Source of this description**:  
@@ -116,7 +116,7 @@ To load plugins you can pass a list of filenames in `ADMINER_PLUGINS`:
 $ docker run --link some_database:db -p 8080:8080 -e ADMINER_PLUGINS='tables-filter tinymce' adminer
 ```
 
-If a plugin *requires* parameters to work correctly you will need to add a custom file to the container:
+If a plugin *requires* parameters to work correctly instead of adding the plugin to `ADMINER_PLUGINS`, you need to add a custom file to the container:
 
 ```console
 $ docker run --link some_database:db -p 8080:8080 -e ADMINER_PLUGINS='login-servers' adminer