From: myglc2 <myglc2@gmail.com>
To: guix-devel@gnu.org
Subject: Re: [PATCH] Quick-start guide
Date: Sun, 12 Jun 2016 11:14:34 -0400 [thread overview]
Message-ID: <86r3c2a17p.fsf@gmail.com> (raw)
In-Reply-To: 20160611174955.GA9544@jasmine
Leo Famulari <leo@famulari.name> writes:
> On Sat, Jun 11, 2016 at 06:43:21AM -0700, yoosty@gmail.com wrote:
>> Upon further reflection.. The Guix manual might not be an appropriate place
>> for such a guide. If the Guix manual isn't a good place for such a set of
>> instructions, do you have any suggestions for a location (blog, etc)?
I think your first intuition was correct: this information should be
added to the manual.
> There is this useful wiki managed by Raymond Nicholson:
> https://gitlab.com/rain1/guix-wiki/wikis/home
>
> Although, I'd like to echo Ludovic's question, and also say that the
> goal of the manual is to be completely sufficient for first-timers and
> experienced users alike.
This is the correct goal, but the manual as it stands is problematic for
first-time users for reasons such as: it's overwhelmingly copious;
information is "shredded" into different sections; the is confusing
terminology; finding one's way around is difficult; there is virtually
no guidance of what to read first or how to proceed.
I see this patch as an attempt to address some of these difficulties.
> I find the phenomenon of 3rd party wikis giving instructions on how to
> use some piece of software to be a dismaying "antipattern". And, the
> situation only gets worse as people send documentation to the 3rd
> party wiki instead of to the software project in questoin.
To avoid the "antipattern" we need to make Guix documentation more
friendly for first-time users and be more _receptive_ to comments and
patches from first-time users.
I suggest we add a new "Getting Started" section between "Introduction"
and "Installation". "Getting Started" should initially include a
discussion of how to decide whether to install Guix or GuixSD and
quick-start sections for each.
This patch should be used as the "GuixSD quick-start" section.
next prev parent reply other threads:[~2016-06-12 15:16 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-04 20:00 [PATCH] Quick-start guide yoosty
2016-06-08 12:47 ` Ludovic Courtès
2016-06-11 13:43 ` yoosty
2016-06-11 17:49 ` Leo Famulari
2016-06-12 15:14 ` myglc2 [this message]
2016-06-12 20:46 ` Ludovic Courtès
2016-06-15 5:07 ` yoosty
2016-06-16 10:51 ` Ludovic Courtès
2016-06-24 4:55 ` yoosty
2016-06-24 12:36 ` Ludovic Courtès
2016-06-13 0:40 ` John Darrington
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=86r3c2a17p.fsf@gmail.com \
--to=myglc2@gmail.com \
--cc=guix-devel@gnu.org \
/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).