You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@steve.apache.org by gs...@apache.org on 2022/04/06 04:45:00 UTC

[steve] 01/06: convert demo.html to .md, and apply some tweaks

This is an automated email from the ASF dual-hosted git repository.

gstein pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/steve.git

commit 44988bb65db295589e77db24ef8d919be95f2998
Author: Greg Stein <gs...@gmail.com>
AuthorDate: Tue Apr 5 22:31:58 2022 -0500

    convert demo.html to .md, and apply some tweaks
---
 site/pages/demo.html | 42 ------------------------------------------
 site/pages/demo.md   | 24 ++++++++++++++++++++++++
 2 files changed, 24 insertions(+), 42 deletions(-)

diff --git a/site/pages/demo.html b/site/pages/demo.html
deleted file mode 100644
index 83b0a1c..0000000
--- a/site/pages/demo.html
+++ /dev/null
@@ -1,42 +0,0 @@
-{% extends "skeleton.html" %}
-
-{% block title %}Apache STeVe{% endblock %}
-{% block content %}
-
-	<h1>Apache STeVe quickstart guide</h1>
-
-	<h2>pySTeVe</h2>
-
-	<h3>Quickstart Guide</h3>
-	<ul style="font-family: monospace;">
-		<li>svn co https://svn.apache.org/repos/asf/steve/trunk/pysteve/</li>
-		<li>Edit steve.cfg to suit your needs (karma, DB backend etc)<br/>
-			IF you choose ElasticSearch as backend, install the python module (pip install elasticsearch)<br/>
-			OR IF you choose files as your backend, run setup.py in the CLI directory.
-		</li>
-		<li>Edit httpd.conf, add it to your existing httpd configuration</li>
-		<li>Set up authorization using htpasswd for admins, monitors etc</li>
-		<li>Go to http://steve.yourdomain.foo/admin and set up an election</li>
-		<li>Start voting!</li>
-	</ul>
-<h3>Building a Docker image</h3>
-  <p>
-	  You can also build pySTeVe as a Docker image using the Dockerfile locate in the <kbd>docker</kbd> directory:
-	  <ul>
-		  <li><kbd>svn co https://svn.apache.org/repos/asf/steve/trunk/pysteve/</kbd></li>
-		  <li><kbd>docker build -t pysteve docker/</kbd></li>
-		  <li><kbd>docker run -i -p 127.0.0.1:80:80 pysteve</kbd></li>
-		  <li>Navigate to http://localhost/admin to set up stuff, using the default credentials (admin/admin1234)</li>
-	  </ul>
-</p>
-	<!--
-	<h3>Online demonstration</h3>
-	<p>
-		If you'd rather try out STeVe before you install it, we have a free-to-try demo online.
-		Simple hop on over to <a href="http://demo.stv.website/">http://demo.stv.website/</a>
-		and mangle it to your hearts content. All data in the demo is wiped once a week.
-		Use the username <kbd>admin</kbd> and password <kbd>demo</kbd> to access the admin area.
-	</p>
-	-->
-
-{% endblock %}
diff --git a/site/pages/demo.md b/site/pages/demo.md
new file mode 100644
index 0000000..4339b00
--- /dev/null
+++ b/site/pages/demo.md
@@ -0,0 +1,24 @@
+Title: Quickstart Guide
+
+## pySTeVe
+
+### Quickstart Guide
+
+  * `svn co https://svn.apache.org/repos/asf/steve/trunk/pysteve/`
+  * Edit `steve.cfg` to suit your needs (karma, DB backend etc)
+    * IF you choose ElasticSearch as backend, install the python module (pip install elasticsearch)
+    * OR IF you choose files as your backend, run setup.py in the CLI directory.
+ * Edit `httpd.conf`, add it to your existing httpd configuration
+ * Set up authorization using htpasswd for admins, monitors etc
+ * Go to `http://steve.example.org/admin` and set up an election
+ * Start voting!
+
+
+### Building a Docker image
+
+You can also build pySTeVe as a Docker image using the Dockerfile locate in the `docker` directory:
+
+ * `svn co https://svn.apache.org/repos/asf/steve/trunk/pysteve/`
+ * `docker build -t pysteve docker/`
+ * `docker run -i -p 127.0.0.1:80:80 pysteve`
+ * Navigate to `http://localhost/admin` to set up stuff, using the default credentials (admin/demo)