README-DEV.adoc: quick-start instructions for editing the tutorial.

Author: alanconway

README-DEV.adoc

@@ -0,0 +1,43 @@
+Modifying the tutorial
+======================
+
+The tutorial is written in asciidoc and can be updated using any text editor.
+You can preview changes as you make them as follows:
+
+1. Install the `antora` website generator and `gulp` build system
++
+....
+npm install -g @antora/cli @antora/site-generator-default gulp gulp-connect gulp-open yaml-js
+....
+
+2. Create a `dev-site.yml` file (the `site.yml` file is for the public website)
++
+.dev-site.yml
+....
+runtime:
+  cache_dir: ./.cache/antora
+
+site:
+  title: Knative Tutorial
+  url: https://redhat-developer-demos.github.io/knative-tutorial
+  start_page: knative-tutorial::index.adoc
+
+content:
+  sources:
+    - url: .
+      branches: HEAD
+      start_path: documentation
+
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: true
+  supplemental_files: ./supplemental-ui
+
+output:
+  dir: ./gh-pages
+....
+
+3. Run `node_modules/.bin/gulp`
+
+This will generate HTML, start a local web server at `localhost:5373`, open the server index in a browser, and automatically update the HTML when the asciidoc source changes.