Skip to content

Update the link to refer the actual documentation #1338

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

Open
EugenKon opened this issue May 7, 2025 · 4 comments
Open

Update the link to refer the actual documentation #1338

EugenKon opened this issue May 7, 2025 · 4 comments

Comments

@EugenKon
Copy link

EugenKon commented May 7, 2025

Image

https://github.com/docker-library/docs/tree/487e4e632d0c0aaac7f70a1026b282ca9307c0df/postgres#postgres_password

@tianon
Copy link
Member

tianon commented May 7, 2025

Can you please be more specific? That link is accurate, and does discuss PGPASSWORD (and is even an actively supported version).

@EugenKon
Copy link
Author

EugenKon commented May 8, 2025

@tianon Sorry, how more specific could I be?

Image

The most recent/actual is current: https://www.postgresql.org/docs/current/libpq-envars.html

@tianon
Copy link
Member

tianon commented May 8, 2025

Sure, but what's the problem with linking to the older release, especially when the top of the page we're linking to links directly to all the releases? I'd be very open to a PR against postgres/content.md in that docs repo you linked to update to https://www.postgresql.org/docs/17/libpq-envars.html, but I won't accept a change to link to /current/ because linking to non-versioned resources like that often leads us to dead links that are harder to track down than a versioned link (because at least there, the wayback machine can typically help us figure out what it was trying to link to so we can find the more recent analog when updating the link). Granted in this case (and most cases in the PG documentation), the page names are pretty stable, but the content isn't necessarily, so when we update, we want to make sure the updated page is still the appropriate place to find the right content we were intending to link to.

@EugenKon
Copy link
Author

EugenKon commented May 8, 2025

Yeah, that is the problem. I did not thought about that. Should it be better to provide both links: 17 and current? So new guys will aware that PostgreSQL has more recent documentation.

Or we can use current for the link and 17 for the link name like this: https://www.postgresql.org/docs/17/libpq-envars.html. Here 17 is displayed, but, actually, it is current.
If link occasionally not work user still have a chance to navigate to exact version manually by copy/pasting it.

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

2 participants