Skip to content

Commit 7a458d9

Browse files
authored
Merge pull request #1193 from infosiftr/repo-stub-wording
Adjust repo stub wording
2 parents 7994e56 + dd8c321 commit 7a458d9

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

generate-repo-stub-readme.sh

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ EOUSAGE
1717
fi
1818

1919
gitRepo='https://github.com/docker-library/docs'
20-
hubPage="https://registry.hub.docker.com/_/$repo/"
20+
hubPage="https://hub.docker.com/_/$repo/"
2121

2222
canonicalRepo="https://github.com/docker-library/$repo"
2323
if [ -s "$repo/github-repo" ]; then
@@ -26,6 +26,8 @@ fi
2626
canonicalRepo="$(curl -fsSLI -o /dev/null -w '%{url_effective}\n' "$canonicalRepo")" # follow redirects (http://stackoverflow.com/a/3077316/433558)
2727
travisRepo="${canonicalRepo#*://github.com/}"
2828

29+
maintainer="$(sed -e 's!%%GITHUB-REPO%%!'"$canonicalRepo"'!g' "$repo/maintainer.md")"
30+
2931
if [ -f "$repo/deprecated.md" ]; then
3032
echo '# DEPRECATED'
3133
echo
@@ -34,13 +36,19 @@ if [ -f "$repo/deprecated.md" ]; then
3436
fi
3537

3638
cat <<EOREADME
37-
# About this Repo
39+
# $canonicalRepo
40+
41+
## Maintained by: $maintainer
42+
43+
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.
44+
45+
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).
3846
39-
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.
47+
## See a change merged here that doesn't show up on Docker Hub yet?
4048
41-
The full readme is generated over in [docker-library/docs]($gitRepo), specifically in [docker-library/docs/$repo]($gitRepo/tree/master/$repo).
49+
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).
4250
43-
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).
51+
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).
4452
EOREADME
4553

4654
badges=()

0 commit comments

Comments
 (0)