Skip to content

ZIP documentation link not anymore latest state of the development branch #12093

Closed
@jidanni

Description

@jidanni

What is the bug?

https://gdal.org/en/stable/download.html#documentation
says

Besides being included when downloading the software, the
documentation is also available independently as a PDF file, and a ZIP
of individual HTML pages for offline browsing. (The ZIP also includes
the PDF.) The documentation reflects the latest state of the
development branch of the software.

OK, but after downloading that ZIP we find it does not reflect the
latest version.

In fact there are little clues as to what version it reflects.

We think the problem might be caused by us getting the link from
https://gdal.org/en/stable/download.html#documentation
where /stable/ might be the culprit.

But double checking that ZIP's address,
https://github.com/OSGeo/gdal-docs/archive/refs/heads/master.zip
it seems to be the link we want.

OK, what are the clues we see when we read that offline version that make us worry we are not looking at the freshest development version?

  • "2024" in " © 1998-2024 Frank Warmerdam, Even Rouault, and others"
  • The words "The NEWS page describes the August 2024 GDAL/OGR 3.9.2 release."
    But maybe that is only talking about the NEWS page.

Note the usual version number in the Readthedocs left side panel is nowhere to
be seen in the offline version. The panel is there but the version is not.

==Suggestions

Somewhere on the front page there offline,
near the words

GDAL
GDAL is a translator library for raster and vector geospatial data
formats that is released under an MIT style Open Source License by the
Open Source Geospatial Foundation. As a...

be sure to add

You are looking at Version x.y.z of the documentation.

Also please make sure the ZIP really does always reflect the latest
development branch state version, like promised above.

Metadata

Metadata

Assignees

Labels

documentationIssues and contributions to the documentation content

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions