unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: swedebugia <swedebugia@riseup.net>
To: Guix-devel <guix-devel@gnu.org>
Subject: Improving the README and new user experience
Date: Wed, 20 Jun 2018 06:46:25 +0200	[thread overview]
Message-ID: <2BB0BF83-FB79-4D6D-AE22-9E8D6B095C75@riseup.net> (raw)

[-- Attachment #1: Type: text/plain, Size: 2299 bytes --]

Hi

I would like to propose a rewrite of the README.

I'm wondering if it would be best to split it up in 2 files. 

One for guix and one for guixsd. 

I would like to help new users understand more about GuixSD before they run it (and inevitably into errors) 

Users come from other Distros where tough package manager errors mostly mean: you are screwed, reinstall. Because if you loose the central command to manipulate the system - how can you possibly recover? Imagine apt being corrupt or gone missing. 

So when we have strong reactions to users used to being screwed and reinstall then we need to educate them that this is something completely different where it is actually hard to break (besides when running guix pull and not understanding how to set paths manually) 

Another example:
The current parsing of config.scm is eh... crude and might work for seasoned programmers who know the exact differences between parameters, instantiated config, where inherit works (record types) and where they don't (service-types), what a service object is, how you remove an item from a list of service objects, etc. 

I would like to tell new users NOT to change the config.scm at first install if they are not confident schemers. (besides the username and timezone perhaps). 

Also the editors included in the image are crap because they lack two important features: 1) keeping track of the damn paranteses and 2) comment and uncomment region. 

Edits to the configuration is in my view best done with small incremental steps in emacs and validating the config for each step (side note how do you validate your config from within emacs?). Access to irc to ask for questions/help when guix sometime spews incomprehensible errors at you is also advisable.

We also need a lot more complete examples of working snippets and whole config.scms to add to a config in the lack of good error reporting. 

Maybe a list of links to working configs from community members would be good to add Somewhere. I learned a lot from reading the
Config of others. Perhaps in a new file called GUIXSD-CONFIGURATION-EXAMPLES? 

I saw that some of you, Alex, sidesteps the removal of service objects-problem by defining all the services yourself in a list instead. 

-- 
Cheers Swedebugia 

[-- Attachment #2: Type: text/html, Size: 2431 bytes --]

             reply	other threads:[~2018-06-20  4:46 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-20  4:46 swedebugia [this message]
2018-06-20  6:13 ` Improving the README and new user experience Dan Partelly
2018-06-20  7:20   ` Pierre Neidhardt
2018-06-20  9:39     ` Dan Partelly
2018-06-24 14:02     ` Dan Partelly
2018-06-20  8:24   ` Danny Milosavljevic
2018-06-20  9:57     ` swedebugia

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=2BB0BF83-FB79-4D6D-AE22-9E8D6B095C75@riseup.net \
    --to=swedebugia@riseup.net \
    --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).