Skip to content

Expand our "repo-info" blurb to link to both the "local" and "remote" directories (and explain a little bit about what each is) #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 6, 2017

Conversation

tianon
Copy link
Member

@tianon tianon commented Sep 9, 2016

No description provided.

@tianon
Copy link
Member Author

tianon commented Sep 9, 2016

@yosifkit
Copy link
Member

yosifkit commented Sep 9, 2016

Those are some really long links. So my initial thought for improving clarity was something like this:

For detailed information about each of the above supported tags, please see the following from the docker-library/repo-info GitHub repo:

But then we discussed where it goes on the hub page and it makes more sense to minimize this part to just a sentence and then link to repo-info/%%REPO%%/ and have a Readme file there that describes what is in each folder. This other readme can then grow and improve as the data in repo-info changes and improves.

@tianon
Copy link
Member Author

tianon commented Apr 6, 2017

A bit long in the works, but here's my proposal for the structure of that repos/%%REPO%%/README.md file:

alpine repo-info

This directory contains additional information about the published artifacts of the alpine official image.

  • the remote directory:

    • gathered from the Docker Hub/Registry API

    • image digests/blobs, transfer sizes, image metadata, etc.

  • the local directory:

    • inspected from the image on-disk after it is pulled

    • installed packages, creation date, architecture, environment variables, detected licenses, etc.

@tianon tianon force-pushed the repo-info-split branch from f53dd06 to 170c632 Compare April 6, 2017 20:30
@tianon
Copy link
Member Author

tianon commented Apr 6, 2017

Alright, this is updated to account for docker-library/repo-info#12 now. 👍

@tianon
Copy link
Member Author

tianon commented Apr 6, 2017

(probably easiest to review commit-by-commit, since the second commit reorders these two paragraphs)

@yosifkit yosifkit merged commit 4e45c6b into docker-library:master Apr 6, 2017
@yosifkit yosifkit deleted the repo-info-split branch April 6, 2017 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants