Patchwork website: Enhance instructions on how to test the website locally.

login
register
mail settings
Submitter sirgazil
Date Nov. 20, 2016, 1:45 a.m.
Message ID <1479606325-2401-1-git-send-email-felipe.lopez@openmailbox.org>
Download mbox | patch
Permalink /patch/17594/
State New
Headers show

Comments

sirgazil - Nov. 20, 2016, 1:45 a.m.
* website/README: Indicate usage of GUIX_WEB_SITE_LOCAL.
---
 website/README | 44 ++++++++++++++++++++++++++++++--------------
 1 file changed, 30 insertions(+), 14 deletions(-)
Ludovic Courtès - Nov. 21, 2016, 2:04 p.m.
sirgazil <felipe.lopez@openmailbox.org> skribis:

> * website/README: Indicate usage of GUIX_WEB_SITE_LOCAL.

LGTM, please push!

Ludo’.
sirgazil - Nov. 21, 2016, 4:14 p.m.
On 2016-11-21 09:04, ludo@gnu.org wrote:
> sirgazil <felipe.lopez@openmailbox.org> skribis:
> 
>> * website/README: Indicate usage of GUIX_WEB_SITE_LOCAL.
> 
> LGTM, please push!
> 
> Ludo’.

Done.

Patch

diff --git a/website/README b/website/README
index 5438a5d..f8dee4a 100644
--- a/website/README
+++ b/website/README
@@ -2,26 +2,42 @@ 
 
 #+TITLE: GuixSD website
 
-The files in this directory are intended to be used as assets for the [[https://www.gnu.org/software/guix][GuixSD
-website]] which is implemented in [[https://www.gnu.org/software/guile][Guile]] Scheme.
+This directory contains the source files for the GuixSD website,
+available at https://www.gnu.org/software/guix/.
 
-  - =www.scm= and =www= provides ‘(www)’ guile module which offers services for
-    building the website locally.
+  - =www.scm= and =www= provide the =(www)= guile module which
+    offers services for building the website locally.
   - =static= contains images and css for the website.
-  - =mockup.svg= illustrates a homepage aimed at average users.  This is for use
-    when GuixSD is getting closer to a production-ready system.
-  - =mockup-techie.svg= illustrates a homepage aimed at skilled devs and
-    sysadmins.  This is for use during the alpha phase of development.
+  - =mockup.svg= illustrates a homepage aimed at average users.
+    This is for use when GuixSD is getting closer to a
+    production-ready system.
+  - =mockup-techie.svg= illustrates a homepage aimed at
+    skilled devs and sysadmins.  This is for use during the
+    alpha phase of development.
 
-* Building
+* Dependencies
 
-Building the website depends on the static site generator:
+To be able to work on the website, you need the following software:
 
-  - [[http://haunt.dthompson.us/][Haunt]]
+  - [[https://www.gnu.org/software/guile/][GNU Guile]] (programming language)
+  - [[http://haunt.dthompson.us/][Haunt]] (static site generator)
 
-To build the site, run ‘haunt build’ to compile all of the HTML pages.
-To view the results, run ‘haunt serve’ and visit <http://localhost:8080>
-in a web browser.
+* Building and running
+
+To try out the website locally while you work on it, run the following
+commands:
+
+#+BEGIN_EXAMPLE
+$ cd path/to/guix-artwork/website
+$ GUIX_WEB_SITE_LOCAL=yes haunt build
+$ haunt serve
+#+END_EXAMPLE
+
+Then, visit http://localhost:8080/ in a web browser.
+
+* Deploying
+
+Pending...
 
 * Copying