Skip to content
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

README should mention how to use the current (or earlier) version #643

Closed
richb-hanover opened this issue Dec 5, 2024 · 3 comments
Closed

Comments

@richb-hanover
Copy link

richb-hanover commented Dec 5, 2024

Details

I'm trying to revive an old project (that used 0.9.22 (!)). I see the README advises use of FROM phusion/baseimage:<VERSION> I couldn't figure out what version number to use (using latest didn't seem to work).

The README should have a Current Status section that lists the current version that displays the exact FROM ... to use and a pointer to the list of earlier "production" versions?

Many thanks.

@samip5
Copy link
Collaborator

samip5 commented Dec 5, 2024

Sorry but I'm gonna mark this as won't fix. I don't believe we should be holding the users hand in figuring this one out.

@samip5 samip5 closed this as not planned Won't fix, can't repro, duplicate, stale Dec 5, 2024
@richb-hanover
Copy link
Author

@samip5 Hmmm... I don't think of it as "handholding". It's more like saving each potential new person five minutes... But that's besides the point. I spent the five minutes, and would offer the following for the README:


Current Status

The current version of the image is always available from the Releases on the home page. To use that image, use docker pull phusion/baseimage:release where release is the name shown at the top of the page.


Advantages:

  • It answers the most common question: how do I use this?
  • It doesn't require maintenance - all the work goes into updating the Release page (which you do anyway)

@Theaxiom
Copy link
Collaborator

Theaxiom commented Dec 7, 2024

@richb-hanover Thank you for the feedback, please submit a PR to the README and we will review and possibly integrate your changes. This is a community project! :)

richb-hanover added a commit to richb-hanover/baseimage-docker that referenced this issue Dec 8, 2024
Add Current Status section as requested by phusion#643
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

No branches or pull requests

3 participants