[Qemu-devel] [qemu-web PATCH] Document how to test the site with jekyll locally

["Daniel P. Berrangé" <berrange@redhat.com>]

Add a README file that tells people this is a jekyll based static
website, and shows people how to run jekyll for testing purposes.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---

NB, we should really mention a license in the README too, but I don't
see info about what license we consider qemu-web to be covered by...

 README      | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 _config.yml |  2 ++
 2 files changed, 55 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..d06606a
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+QEMU Webite
+===========
+
+This repository provides content for the QEMU website.
+
+It uses the Jekyll site generator for turning the static content into
+a format which can then be directly hosted by a regular HTTP server
+such as Apache.
+
+
+Testing locally with Jekyll
+---------------------------
+
+When adding/changing content on this site, it is possible to run a
+local Jekyll service to test the result.
+
+QEMU requires a specific version of Jekyll which may not match that
+provided by your OS vendor. Thus as a one time step the Jekyll software
+must be installed locally as follows:
+
+* Install OS vendor ruby with development headers
+
+   # sudo dnf install ruby ruby-devel  (Fedora)
+   # sudo yum install ruby ruby-devel  (RHEL)
+   # sudo apt-get install ruby ruby-dev (Debian / Ubuntu)
+
+* Install OS vendor ruby gem bundler
+
+   # sudo dnf install rubygem-bundler  (Fedora)
+   # sudo yum install rubygem-bundler  (RHEL)
+   # sudo apt-get install bundler (Debian / Ubuntu)
+
+* Install Jekyll and its dependencies
+
+   # bundle install --path vendor
+
+Jekyll is now installed into the 'vendor/' directory of the git checkout.
+Note the 'vendor/' path has been explicitly excluded from the web content
+in _config.yml, so don't try to use a different path within the git
+checkout.
+
+
+To test the site launch jeykll
+
+  # bundle exec jekyll serve
+
+Now simply point a local web browser to http://127.0.0.1:4000 to browse
+the generated site.
+
+Jekyll will usually automatically detect changes to files in the git
+checkout and regenerate the site. It is thus not normally neccessary
+to restart jekyll after changing content, unless it shows signs of being
+confused / stale.
diff --git a/_config.yml b/_config.yml
index 0a0201c..576b0a5 100644
--- a/_config.yml
+++ b/_config.yml
@@ -37,3 +37,5 @@ gems:
 exclude:
   - Gemfile
   - Gemfile.lock
+  - vendor/
+  - README
-- 
2.19.2