Browse Source

Merge pull request #1193 from infosiftr/repo-stub-wording

Adjust repo stub wording
yosifkit 7 years ago
parent
commit
7a458d9b0b
1 changed files with 13 additions and 5 deletions
  1. 13 5
      generate-repo-stub-readme.sh

+ 13 - 5
generate-repo-stub-readme.sh

@@ -17,7 +17,7 @@ EOUSAGE
 fi
 
 gitRepo='https://github.com/docker-library/docs'
-hubPage="https://registry.hub.docker.com/_/$repo/"
+hubPage="https://hub.docker.com/_/$repo/"
 
 canonicalRepo="https://github.com/docker-library/$repo"
 if [ -s "$repo/github-repo" ]; then
@@ -26,6 +26,8 @@ fi
 canonicalRepo="$(curl -fsSLI -o /dev/null -w '%{url_effective}\n' "$canonicalRepo")" # follow redirects (http://stackoverflow.com/a/3077316/433558)
 travisRepo="${canonicalRepo#*://github.com/}"
 
+maintainer="$(sed -e 's!%%GITHUB-REPO%%!'"$canonicalRepo"'!g' "$repo/maintainer.md")"
+
 if [ -f "$repo/deprecated.md" ]; then
 	echo '# DEPRECATED'
 	echo
@@ -34,13 +36,19 @@ if [ -f "$repo/deprecated.md" ]; then
 fi
 
 cat <<EOREADME
-# About this Repo
+# $canonicalRepo
+
+## Maintained by: $maintainer
+
+This is the Git repo of the [Docker "Official Image"](https://docs.docker.com/docker-hub/official_repos/) for [$repo]($hubPage) (not to be confused with any official $repo image provided by $repo upstream). See [the Docker Hub page]($hubPage) for the full readme on how to use this Docker image and for information regarding contributing and issues.
+
+The [full description from Docker Hub]($hubPage) is generated over in [docker-library/docs]($gitRepo), specifically in [docker-library/docs/$repo]($gitRepo/tree/master/$repo).
 
-This is the Git repo of the Docker [official image](https://docs.docker.com/docker-hub/official_repos/) for [$repo]($hubPage). See [the Docker Hub page]($hubPage) for the full readme on how to use this Docker image and for information regarding contributing and issues.
+## See a change merged here that doesn't show up on Docker Hub yet?
 
-The full readme is generated over in [docker-library/docs]($gitRepo), specifically in [docker-library/docs/$repo]($gitRepo/tree/master/$repo).
+Check [the "library/$repo" manifest file in the docker-library/official-images repo](https://github.com/docker-library/official-images/blob/master/library/$repo), especially [PRs with the "library/$repo" label on that repo](https://github.com/docker-library/official-images/labels/library%2F$repo).
 
-See a change merged here that doesn't show up on the Docker Hub yet? Check [the "library/$repo" manifest file in the docker-library/official-images repo](https://github.com/docker-library/official-images/blob/master/library/$repo), especially [PRs with the "library/$repo" label on that repo](https://github.com/docker-library/official-images/labels/library%2F$repo). For more information about the official images process, see the [docker-library/official-images readme](https://github.com/docker-library/official-images/blob/master/README.md).
+For more information about the official images process, see the [docker-library/official-images readme](https://github.com/docker-library/official-images/blob/master/README.md).
 EOREADME
 
 badges=()