bug#22687: Online manual not updated automatically

bug#22687: Online manual not updated automatically

[Leo Famulari]

----- Forwarded message from carl hansen <carlhansen1234@gmail.com> -----
 http://www.gnu.org/software/guix/manual/
works.
BUT
it says:
"last updated November 04, 2015"
So cronjob on gnu.org that updates to the lastest version is not working.
Might
be the answer to the problem about , too.

----- End forwarded message -----

I see the value of the online manual matching the version of the Guix
binaries we distribute, but on the other hand, we get a lot of questions
that are answered in the latest version of the manual.

Thoughts?

bug#22687: Online manual not updated automatically

[Thompson, David]

On Mon, Feb 15, 2016 at 4:50 PM, Leo Famulari <leo@famulari.name> wrote:
> ----- Forwarded message from carl hansen <carlhansen1234@gmail.com> -----
>  http://www.gnu.org/software/guix/manual/
> works.
> BUT
> it says:
> "last updated November 04, 2015"
> So cronjob on gnu.org that updates to the lastest version is not working.
> Might
> be the answer to the problem about , too.
>
> ----- End forwarded message -----
>
> I see the value of the online manual matching the version of the Guix
> binaries we distribute, but on the other hand, we get a lot of questions
> that are answered in the latest version of the manual.
>
> Thoughts?

IMO, this is a "wontfix", but let's see what everyone else thinks.

- Dave

bug#22687: Online manual not updated automatically

[Ricardo Wurmus]

Leo Famulari <leo@famulari.name> writes:

> I see the value of the online manual matching the version of the Guix
> binaries we distribute, but on the other hand, we get a lot of questions
> that are answered in the latest version of the manual.

Many other projects publish online manuals for both stable and
development versions.  As our releases are a little far apart and we’re
encouraging to do “guix pull” (so users really run the development
version) I think it would indeed make sense to also publish an
up-to-date version of the manual along with the manual for the latest
release.

~~ Ricardo

bug#22687: Online manual not updated automatically

[Andreas Enge]

On Tue, Feb 16, 2016 at 11:06:40AM +0100, Ricardo Wurmus wrote:
> Many other projects publish online manuals for both stable and
> development versions.  As our releases are a little far apart and we’re
> encouraging to do “guix pull” (so users really run the development
> version) I think it would indeed make sense to also publish an
> up-to-date version of the manual along with the manual for the latest
> release.

Or alternatively, release more often :-)

I wonder whether we should not make a point release after each security
update instead of encouraging people to use "guix pull" (but we would
quickly arrive at 0.9.9 now, after which only 1.0.0 would be a reasonable
option to keep numerical and lexicographical ordering consistent).
Or a point-point release as 0.9.0.1 and so on.

Andreas

bug#22687: Online manual not updated automatically

[Ricardo Wurmus]

Andreas Enge <andreas@enge.fr> writes:

> On Tue, Feb 16, 2016 at 11:06:40AM +0100, Ricardo Wurmus wrote:
>> Many other projects publish online manuals for both stable and
>> development versions.  As our releases are a little far apart and we’re
>> encouraging to do “guix pull” (so users really run the development
>> version) I think it would indeed make sense to also publish an
>> up-to-date version of the manual along with the manual for the latest
>> release.
>
> Or alternatively, release more often :-)

I was not courageous enough to suggest that, but this does sound like a
good idea.

> I wonder whether we should not make a point release after each security
> update instead of encouraging people to use "guix pull" (but we would
> quickly arrive at 0.9.9 now, after which only 1.0.0 would be a reasonable
> option to keep numerical and lexicographical ordering consistent).
> Or a point-point release as 0.9.0.1 and so on.

I would like that.  We could make patch releases for each time we merge
core-updates / security-fixes into master.

~~ Ricardo

bug#22687: Online manual not updated automatically

[Andreas Enge]

On Tue, Feb 16, 2016 at 05:33:27PM +0100, Ricardo Wurmus wrote:
> I was not courageous enough to suggest that, but this does sound like a
> good idea.

It is easy enough to have that courage when one is not the person making
the releases :-)

Andreas

bug#22687: Online manual not updated automatically

[Florian Paul Schmidt]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 16.02.2016 17:42, Andreas Enge wrote:
> On Tue, Feb 16, 2016 at 05:33:27PM +0100, Ricardo Wurmus wrote:
>> I was not courageous enough to suggest that, but this does sound
>> like a good idea.
> 
> It is easy enough to have that courage when one is not the person
> making the releases :-)

Hmm, shouldn't that process be mostly automated? And if not, maybe
it's worth thinking about how to do that. I guess from a functional
point of view a release is just a function that takes a revision and
has as its outputs installer images, binary installers, a new website,
yada yada yada..

Regards,
Flo


- -- 
https://fps.io
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBCAAGBQJWw1kKAAoJEA5f4Coltk8Z/6sH/1CuqcAbB+RC/b4bmyBkSJ0z
SlJBjkfs9BUxLtjzLXMn52t0dKOmA92CiVpZblTxb0M3rcruOY44Wlkc3J5PqP3U
Aqh+YzrowqKHBi+iikftiJYj9X7beh7rWxmM48nWkdtPTfLUYdbi5+AJtz7bwvQ8
ZHx5wilEVaUnXKyiora3V2Nm8bjGQXIfncvQy7rrON2XaNZut8ruIAI0FSn8F4xD
WPWP5tuTTdHJNCOSmsPr1kM2kmoBZ3hDs4BeJWbiTUMJTsh3G/P+z1XUBuoS3zWJ
CwYrTwZzulq9JTP10JdMOEBcoZ9/za3cpiHM2n8rA1CEpVKRKM/s9tnKZjl+oZ8=
=ODkW
-----END PGP SIGNATURE-----

bug#22687: Online manual not updated automatically

[Mathieu Lirzin]

Florian Paul Schmidt <mista.tapas@gmx.net> writes:

> On 16.02.2016 17:42, Andreas Enge wrote:
>> On Tue, Feb 16, 2016 at 05:33:27PM +0100, Ricardo Wurmus wrote:
>>> I was not courageous enough to suggest that, but this does sound
>>> like a good idea.
>> 
>> It is easy enough to have that courage when one is not the person
>> making the releases :-)
>
> Hmm, shouldn't that process be mostly automated? And if not, maybe
> it's worth thinking about how to do that. I guess from a functional
> point of view a release is just a function that takes a revision and
> has as its outputs installer images, binary installers, a new website,
> yada yada yada..

IIUC The problem is that making a release involves a lot a build power
that take long long time and makes it difficult to resolve unavoidable
issues encountered during the process.

I remember hearing Ludo explaining that the release process for Guix was
more involving than for the other software projects he experienced.

--
Mathieu Lirzin

bug#22687: Online manual not updated automatically

[Chris Marusich]

Ricardo Wurmus <ricardo.wurmus@mdc-berlin.de> writes:

> Many other projects publish online manuals for both stable and
> development versions.  As our releases are a little far apart and we’re
> encouraging to do “guix pull” (so users really run the development
> version) I think it would indeed make sense to also publish an
> up-to-date version of the manual along with the manual for the latest
> release.

Does guix pull not update the manual?

- Chris

bug#22687: Online manual not updated automatically

[Alex Kost]

Chris Marusich (2016-02-17 07:07 +0300) wrote:

> Ricardo Wurmus <ricardo.wurmus@mdc-berlin.de> writes:
>
>> Many other projects publish online manuals for both stable and
>> development versions.  As our releases are a little far apart and we’re
>> encouraging to do “guix pull” (so users really run the development
>> version) I think it would indeed make sense to also publish an
>> up-to-date version of the manual along with the manual for the latest
>> release.
>
> Does guix pull not update the manual?

No, currently it updates only the scheme code.

-- 
Alex

bug#22687: Online manual not updated automatically

[Ludovic Courtès]

Mathieu Lirzin <mthl@gnu.org> skribis:

> Florian Paul Schmidt <mista.tapas@gmx.net> writes:
>
>> On 16.02.2016 17:42, Andreas Enge wrote:
>>> On Tue, Feb 16, 2016 at 05:33:27PM +0100, Ricardo Wurmus wrote:
>>>> I was not courageous enough to suggest that, but this does sound
>>>> like a good idea.
>>> 
>>> It is easy enough to have that courage when one is not the person
>>> making the releases :-)
>>
>> Hmm, shouldn't that process be mostly automated? And if not, maybe
>> it's worth thinking about how to do that. I guess from a functional
>> point of view a release is just a function that takes a revision and
>> has as its outputs installer images, binary installers, a new website,
>> yada yada yada..
>
> IIUC The problem is that making a release involves a lot a build power
> that take long long time and makes it difficult to resolve unavoidable
> issues encountered during the process.
>
> I remember hearing Ludo explaining that the release process for Guix was
> more involving than for the other software projects he experienced.

Yeah it typically takes a lot of time waiting for builds and uploads to
complete.  See ‘release.org’ in guix-maintenance.git for a feel.

If people have ideas on how to improve the process, I’m all ears!  :-)

Ludo’.

bug#22687: Online manual not updated automatically

[Ludovic Courtès]

Ricardo Wurmus <ricardo.wurmus@mdc-berlin.de> skribis:

> Many other projects publish online manuals for both stable and
> development versions.  As our releases are a little far apart and we’re
> encouraging to do “guix pull” (so users really run the development
> version) I think it would indeed make sense to also publish an
> up-to-date version of the manual along with the manual for the latest
> release.

Yeah, sounds like we should do that, probably by setting up a cron job
on one of the machines.

I’ll see what can be done if nobody beats me at it.

Ludo’.

bug#22687: Online manual not updated automatically

[Julien Lepiller]

Following swedebugia's example, I suggest we close this bug, since we 
now have https://guix.info/manual/{de,en,fr}

should we advertise that version better from the main website at 
gnu.org?

bug#22687: Online manual not updated automatically

[Ricardo Wurmus]

Julien Lepiller <julien@lepiller.eu> writes:

> Following swedebugia's example, I suggest we close this bug, since we
> now have https://guix.info/manual/{de,en,fr}
>
> should we advertise that version better from the main website at
> gnu.org?

I’d prefer not to advertise guix.info just yet.  If we get the
guix.gnu.org subdomain (+ DNS delegation) set up without problems then
we might just let guix.info disappear into the void.

--
Ricardo

bug#22687: Online manual not updated automatically

[Julien Lepiller]

We now have guix.gnu.org/manual and /manual/devel, which I think implements this issue. Should we close it now?

bug#22687: Online manual not updated automatically

[Leo Famulari]

On Wed, Jul 31, 2019 at 05:31:59PM +0200, Julien Lepiller wrote:
> We now have guix.gnu.org/manual and /manual/devel, which I think implements this issue. Should we close it now?

Yes :)

Thanks for the reminder