Thread: URL for latest PostgreSQL documentation?
A small suggestion for the website...
As someone maintaining the .NET driver for PostgreSQL, it would be good to be able to link to the latest version of the docs, including to specific pages within the docs but without referencing a specific version number. For example, links to documentation pages are included inside our source code (for doc generation), and I'd like to avoid a pass to bump version numbers every time a release is made...
Shay
I'm not exactly sure when the "devel" version is updated but if you want a single source of authority that would be it.
David J.
On Mon, Mar 16, 2015 at 10:56 PM, Shay Rojansky <roji@roji.org> wrote:
A small suggestion for the website...As someone maintaining the .NET driver for PostgreSQL, it would be good to be able to link to the latest version of the docs, including to specific pages within the docs but without referencing a specific version number. For example, links to documentation pages are included inside our source code (for doc generation), and I'd like to avoid a pass to bump version numbers every time a release is made...Shay
That's close but as you say it shows the current development version, which isn't where we want to send users, I think...
Ideally there would be a similar http://www.postgresql.org/docs/latest/static/index.html?
On Tue, Mar 17, 2015 at 7:59 AM, David G. Johnston <david.g.johnston@gmail.com> wrote:
I'm not exactly sure when the "devel" version is updated but if you want a single source of authority that would be it.David J.On Mon, Mar 16, 2015 at 10:56 PM, Shay Rojansky <roji@roji.org> wrote:A small suggestion for the website...As someone maintaining the .NET driver for PostgreSQL, it would be good to be able to link to the latest version of the docs, including to specific pages within the docs but without referencing a specific version number. For example, links to documentation pages are included inside our source code (for doc generation), and I'd like to avoid a pass to bump version numbers every time a release is made...Shay
While its true you are going to end up pointing to features that may not yet be in a released version you still have to deal with that dynamic if your user is using 9.0 and you point them to the 9.4 (even if you call it latest) documentation.
It should be reasonably simple to add a rewrite directive to whatever webserver we are using so that "latest" acts as an alias that can be updated once per release; though maybe that isn't the best solution depending on traffic volumes...I've never operated a site at the scale our documentation likely sees.
David J.
On Mon, Mar 16, 2015 at 11:01 PM, Shay Rojansky <roji@roji.org> wrote:
That's close but as you say it shows the current development version, which isn't where we want to send users, I think...Ideally there would be a similar http://www.postgresql.org/docs/latest/static/index.html?On Tue, Mar 17, 2015 at 7:59 AM, David G. Johnston <david.g.johnston@gmail.com> wrote:I'm not exactly sure when the "devel" version is updated but if you want a single source of authority that would be it.David J.On Mon, Mar 16, 2015 at 10:56 PM, Shay Rojansky <roji@roji.org> wrote:A small suggestion for the website...As someone maintaining the .NET driver for PostgreSQL, it would be good to be able to link to the latest version of the docs, including to specific pages within the docs but without referencing a specific version number. For example, links to documentation pages are included inside our source code (for doc generation), and I'd like to avoid a pass to bump version numbers every time a release is made...Shay
You're right about users possibly seeing docs for versions newer than what they're using, but of course we have no knowledge about the latter... At least we know what the latest stable version is...
(at least from my experience running large websites, a rewrite directive in nginx/Apache is quite negligible, but of course I know nothing about the PostgreSQL WWW setup)
On Tue, Mar 17, 2015 at 8:08 AM, David G. Johnston <david.g.johnston@gmail.com> wrote:
While its true you are going to end up pointing to features that may not yet be in a released version you still have to deal with that dynamic if your user is using 9.0 and you point them to the 9.4 (even if you call it latest) documentation.It should be reasonably simple to add a rewrite directive to whatever webserver we are using so that "latest" acts as an alias that can be updated once per release; though maybe that isn't the best solution depending on traffic volumes...I've never operated a site at the scale our documentation likely sees.David J.On Mon, Mar 16, 2015 at 11:01 PM, Shay Rojansky <roji@roji.org> wrote:That's close but as you say it shows the current development version, which isn't where we want to send users, I think...Ideally there would be a similar http://www.postgresql.org/docs/latest/static/index.html?On Tue, Mar 17, 2015 at 7:59 AM, David G. Johnston <david.g.johnston@gmail.com> wrote:I'm not exactly sure when the "devel" version is updated but if you want a single source of authority that would be it.David J.On Mon, Mar 16, 2015 at 10:56 PM, Shay Rojansky <roji@roji.org> wrote:A small suggestion for the website...As someone maintaining the .NET driver for PostgreSQL, it would be good to be able to link to the latest version of the docs, including to specific pages within the docs but without referencing a specific version number. For example, links to documentation pages are included inside our source code (for doc generation), and I'd like to avoid a pass to bump version numbers every time a release is made...Shay
<p dir="ltr"><br /> On Mar 17, 2015 7:01 AM, "Shay Rojansky" <<a href="mailto:roji@roji.org">roji@roji.org</a>> wrote:<br/> ><br /> > That's close but as you say it shows the current development version, which isn't where we wantto send users, I think...<br /> ><br /> > Ideally there would be a similar <a href="http://www.postgresql.org/docs/latest/static/index.html">http://www.postgresql.org/docs/latest/static/index.html</a>?<br />><br /><p dir="ltr">Replace "latest" with "current" and I think you have what you're looking for. <p dir="ltr">/Magnus<br />
Great, thanks Magnus?
Then may I suggest adding a link in http://www.postgresql.org/docs/, in the line of "the documentation for the latest version can always be found here".
Thanks again!
On Tue, Mar 17, 2015 at 8:13 AM, Magnus Hagander <magnus@hagander.net> wrote:
On Mar 17, 2015 7:01 AM, "Shay Rojansky" <roji@roji.org> wrote:
>
> That's close but as you say it shows the current development version, which isn't where we want to send users, I think...
>
> Ideally there would be a similar http://www.postgresql.org/docs/latest/static/index.html?
>Replace "latest" with "current" and I think you have what you're looking for.
/Magnus
On 17 March 2015 at 14:17, Shay Rojansky <roji@roji.org> wrote:
Great, thanks Magnus?Then may I suggest adding a link in http://www.postgresql.org/docs/, in the line of "the documentation for the latest version can always be found here".
I tend to agree. /current/ isn't very discoverable. Personally I'd love to see it as the first link in the version bar.
--