From mboxrd@z Thu Jan 1 00:00:00 1970 From: Laura Lazzati Subject: Re: We need your feedback of the documentation videos! Date: Thu, 8 Aug 2019 12:04:02 -0300 Message-ID: References: <87d0i9gfme.fsf@elephly.net> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="00000000000074c92c058f9c608e" Return-path: Received: from eggs.gnu.org ([2001:470:142:3::10]:34260) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hvjy6-0002py-Pi for guix-devel@gnu.org; Thu, 08 Aug 2019 11:04:44 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hvjy5-0007SQ-Dd for guix-devel@gnu.org; Thu, 08 Aug 2019 11:04:42 -0400 Received: from mail-wr1-x42a.google.com ([2a00:1450:4864:20::42a]:33505) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hvjy5-0007QZ-6e for guix-devel@gnu.org; Thu, 08 Aug 2019 11:04:41 -0400 Received: by mail-wr1-x42a.google.com with SMTP id n9so95393527wru.0 for ; Thu, 08 Aug 2019 08:04:40 -0700 (PDT) In-Reply-To: <87d0i9gfme.fsf@elephly.net> List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: Ricardo Wurmus Cc: Guix-devel --00000000000074c92c058f9c608e Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi! I will start fixing what we can from the videos :) Will be answering video by video to see what we can change and what we cannot unless we record again the transcript :/ 01-installation-from-script: - at 01:15 the URL is broken in an odd manner. This can be fixed in one of these ways: a) use a shorter existing URL: https://git.sv.gnu.org/cgit/guix.git/plain/etc/guix-install.sh b) realize that the URL is still too long and create an alias at https://guix.gnu.org/install.sh and use that. I will try using both links, if a) is still too long will make you know so that we create b). - at 01:20 the GPG key is fetched from the SKS servers, which expose users to attacks. This should be replaced with the new method to fetch the GPG key. - at 01:30 Ludo=E2=80=99s name is mangled. Looks like an encoding problem. Will install it from scratch again to fix the first issue, and as regards Ludo's name what I show was the output of fetching the key. Will go back to this after the installation. - at 01:35 the output has been altered. We are not using stars in the logo. What is the reason for altering the output? There was a kind of encoding issue, the actual logo was not being shown with the script so tried to fix it like that :/ - at 02:00 the output looks odd=E2=80=A6 is the script really creating =E2=80=9C=E2=80=9D and then again =E2=80=9C=E2=80=9D? If this has been edited: why? This is really a mistake :) To fix! - at 02:15 the way =E2=80=9C# yes=E2=80=9D is input would not work in real = life because =E2=80=9C# yes=E2=80=9D is not =E2=80=9Cyes=E2=80=9D. Is this a limitati= on of the video generation scripts? Don't get this very well, the # is just to show that the user is root, but we can remove it if it is confusing. - at 02:50 the command should probably be =E2=80=9Cguix install hello=E2=80= =9D instead of =E2=80=9Cguix package -i hello=E2=80=9D. Yes, the video is outdated since it was created. - at the same mark there is a series of dots, which is not produced by Guix. Why have they been added? This is done in most videos, they are used to kind of show that something goes in between but it is not relevant to show it. Do you have any other idea for that? - at 02:55 the environment variable hint is outdated. Guix now prints something shorter. Again outdated. - at 3:10 the URL is printed in italics, which makes it harder to read. We should probably use =E2=80=9Chttps://guix.gnu.org/manual=E2=80=9D. This is something to fix in all videos. Regards :) Laura --00000000000074c92c058f9c608e Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Hi!
I will start fixing what we can fr= om the videos :) Will be answering video by video to see what we can change= and what we cannot unless we record again the transcript :/

=
01-installation-from-script:
- a= t 01:15 the URL is broken in an odd manner.=C2=A0 This can be fixed in one= =C2=A0 of these ways:
=C2=A0 = a) use a shorter existing URL:
=C2= =A0 https://git.sv.gnu.org/cgit/guix.git/plain/etc/guix-install.sh
<= /div>
=C2=A0 b) realize that the URL is stil= l too long and create an alias at
= =C2=A0 https://guix.gnu.org/ins= tall.sh and use that.
I will try using both links, if a) is still = too long will make you know so that we create b).

- at 01:20= the GPG key is fetched from the SKS servers, which expose
=C2=A0 users = to attacks.=C2=A0 This should be replaced with the new method to
=C2=A0 = fetch the GPG key.
- at 01:30 Ludo=E2=80=99s name is mangled.=C2=A0 Look= s like an encoding problem.
Will install it from scratch again to= fix the first issue, and as regards Ludo's name what I show was the ou= tput of fetching the key. Will go back to this after the installation.

= - at 01:35 the output has been altered.=C2=A0 We are not using stars in the=
=C2=A0 logo.=C2=A0 What is the reason for altering the output?
There was a kind of encoding issue, the actual logo was not bei= ng shown with the script so tried to fix it like that :/

- at 02:00 the= output looks odd=E2=80=A6 is the script really creating
=C2=A0 =E2=80= =9C<guixbuilder01 to 10>=E2=80=9D and then again =E2=80=9C<guixbui= lder08>=E2=80=9D?=C2=A0 If this has
=C2=A0 been edited: why?
Thi= s is really a mistake :) To fix!

- at 02:15 the way =E2=80=9C# yes=E2=80=9D is input would not wor= k in real life because
=C2=A0 =E2=80=9C# yes=E2=80=9D is not =E2=80=9Cye= s=E2=80=9D.=C2=A0 Is this a limitation of the video generation
=C2=A0 sc= ripts?
Don't get this very well, the # is just to s= how that the user is root, but we can remove it if it is confusing.
- at 02:50 the command should probably be= =E2=80=9Cguix install hello=E2=80=9D instead
=C2=A0 of =E2=80=9Cguix pa= ckage -i hello=E2=80=9D.
Yes, the video is outdated since i= t was created.

- at the s= ame mark there is a series of dots, which is not produced by
=C2=A0 Guix= .=C2=A0 Why have they been added?
This is done in most videos, they ar= e used to kind of show that something goes in between but it is not relevan= t to show it. Do you have any other idea for that?
- at 02:55 the environment variable hint is outdated.= =C2=A0 Guix now prints
=C2=A0 something shorter.
Again outdated.
- at 3:10 the URL is printed in= italics, which makes it harder to read.
=C2=A0 We should probably use = =E2=80=9Chttps://guix.gnu.org/manua= l=E2=80=9D.
This is something to fix in all videos.

Regards :)
Laura





--00000000000074c92c058f9c608e--