From: zimoun <zimon.toutoune@gmail.com>
To: "Sébastien FARGE" <sebastien.farge925@orange.fr>, 59277@debbugs.gnu.org
Subject: bug#59277: Latest guix documentation - version number scrambled ?
Date: Wed, 16 Nov 2022 10:06:48 +0100 [thread overview]
Message-ID: <87cz9n46af.fsf@gmail.com> (raw)
In-Reply-To: <668422246.697519.1668527798506.JavaMail.open-xchange@opme11oxm11nd1.pom.fr.intraorange>
Hi,
On Tue, 15 Nov 2022 at 16:56, Sébastien FARGE <sebastien.farge925@orange.fr> wrote:
>>> 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:
https://ftp.gnu.org/gnu/guix/
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:
https://guix.gnu.org/en/download/latest/
A more convoluted solution would to introduce another version label as
RELEASE-VERSION and use it in these places in the manual.
Cheers,
simon
next prev parent reply other threads:[~2022-11-16 9:34 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <956989375.2295039.1667428307829.JavaMail.open-xchange@opme11oxm08nd1.pom.fr.intraorange>
2022-11-14 10:36 ` bug#59277: Latest guix documentation - version number scrambled ? Sébastien FARGE
2022-11-15 14:45 ` zimoun
2022-11-15 15:56 ` Sébastien FARGE
2022-11-16 9:06 ` zimoun [this message]
2022-11-16 11:26 ` Sébastien FARGE
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87cz9n46af.fsf@gmail.com \
--to=zimon.toutoune@gmail.com \
--cc=59277@debbugs.gnu.org \
--cc=sebastien.farge925@orange.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).