Sébastien FARGE wrote 2 years ago
(name . bug-guix)(address . bug-guix@gnu.org)
1493163212.367763.1668422211954.JavaMail.open-xchange@opme11oxm02nd1.pom.fr.intraorange
Latest guix documentation - version number scrambled ?
- Open
Details
- 2 participants
- Sébastien FARGE
- zimoun
- Owner
- unassigned
- Submitted by
- Sébastien FARGE
- Severity
- normal
zimoun wrote 2 years ago
87iljg8ef7.fsf@gmail.com
Hi,
On lun., 14 nov. 2022 at 11:36, Sébastien FARGE <sebastien.farge925@orange.fr> wrote:
Toggle quote (3 lines)
> On the front page (https://guix.gnu.org/en/manual/devel/fr/)the
> version number is replaced by a strange number 'e26b529'.
This is the commit against which the documentation had been built.
Toggle quote (4 lines)
> A consequence is that all links using the version number are broken.
>
> For exemple, on the page : https://guix.gnu.org/en/manual/devel/en/html_node/USB-Stick-and-DVD-Installation.html#Copying-to-a-USB-Stick
Indeed, but the image is not built for each commit. Well, I do not know
if it is fixable – or if it makes sense to fix. It is the devel manual
after all. ;-)
Toggle quote (2 lines)
> i failed to download the iso image named : https://ftp.gnu.org/gnu/guix/guix-system-install-e26b529.x86_64-linux.iso’
Specifically, the images are updated for each release, only.
For the latest images, please see:
Cheers,
simon
Sébastien FARGE wrote 2 years ago
668422246.697519.1668527798506.JavaMail.open-xchange@opme11oxm11nd1.pom.fr.intraorange
zimoun wrote 2 years ago
87cz9n46af.fsf@gmail.com
Hi,
On Tue, 15 Nov 2022 at 16:56, Sébastien FARGE <sebastien.farge925@orange.fr> wrote:
Toggle quote (10 lines)
>>> A consequence is that all links using the version number are broken.
>>>
>>> For exemple, on the page : https://guix.gnu.org/en/manual/devel/en/html_node/USB-Stick-and-DVD-Installation.html#Copying-to-a-USB-Stick
>>
>> Indeed, but the image is not built for each commit. Well, I do not know
>> if it is fixable – or if it makes sense to fix. It is the devel manual
>> after all. ;-)
>
> Does a documentation with broken links makes sense ?
The point is that the (devel) manual is referring to some release only URLs:
The images there are only updated when a new release is out. It is not
a rolling-release URL updated by the CI but a very stable URL manually
updated (I guess).
This URL in the manual is generated by
@indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso},
where VERSION is from version.texi generated at compile-time, IIRC.
The simplest is to add a warning note mentioning the issue and pointing to:
A more convoluted solution would to introduce another version label as
RELEASE-VERSION and use it in these places in the manual.
Cheers,
simon
Sébastien FARGE wrote 2 years ago
522667048.64721.1668597977257.JavaMail.open-xchange@opme11oxm12nd1.pom.fr.intraorange
?