Changes between Version 2 and Version 3 of hct

Timestamp:

Dec 28, 2012, 5:48:23 PM (11 years ago)

Author:

Jamie McClelland

Comment:

--

hct

@@ +1 @@
+[[PageOutline]]
 = Here Comes Trouble =
 
+== Overview ==
 `Here Comes Trouble` (htc) is a package for helping the support team with communications during an outage. It facilitates communicating service advisory messages to MF/PL members.
 
 htc consists of the following components:
 
- * messages git repo - this is a git repository with three subdirectories:
+ * messages git repo - this repo contains all service advisory messages in raw format as well as message and web templates. There is one messages repo for the live installation and one for the dev installation. Each repo has three subdirectories: 
   * templates - pre-written and translated templates for common service advisories
   * queue - messages queued for translation or approval
@@ -17 +19 @@
 
 htc is designed to require only a workstation with the appropriate (and reasonably up-to-date) software installed and Internet access between the workstation and jojobe.mayfirst.org (our server hosted in the UK).
+
+== Getting Started ==
+
+hct can function on either a live or dev installation. As of December 2012 we only have a dev installation running.
+
+ * Checkout a copy of trouble via git:
+{{{
+git clone git://git.mayfirst.org/mfpl/trouble
+}}}
+ * Optionally symlink it in your ~/bin directory
+ * Checkout a copy of the messages repo:
+{{{
+git clone hct-dev@jojobe.mayfirst.org:/srv/hct-dev/messages/repo-hub
+}}}
+ * Try releasing a message:
+{{{
+cd /path/to/messages/repo
+trouble message
+}}}
 
 == trouble ==