From b2082175e32930811d49aa4ec551f286e1d3994b Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Fri, 12 Sep 2014 16:21:50 -0400 Subject: [PATCH] Little more doc work, fix versioned plugin thinko. --- docs/hacking.md | 2 -- docs/plugin-use.md | 22 ++++++++++++++++------ plugins/versioned.lisp | 2 ++ 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/hacking.md b/docs/hacking.md index 94abc47..076fad1 100644 --- a/docs/hacking.md +++ b/docs/hacking.md @@ -217,8 +217,6 @@ PAGE, a content type for static page support, is available as a plugin. ### TODO for 0.9.6 -* Finish docs updates to: - * plugin-use.md -> Incremental plugin, Versioned plugin. Twitter summary cards. * A real test suite with Stefil that at *least* tests: * `read-content` * `load-config` diff --git a/docs/plugin-use.md b/docs/plugin-use.md index 7164c61..b614a1f 100644 --- a/docs/plugin-use.md +++ b/docs/plugin-use.md @@ -1,8 +1,8 @@ # General Use -* Add a list with the plugin name and settings to the ```:plugins``` - section of your [.coleslawrc][config_file]. Plugin settings are - described below. +* To enable a plugin, add its name and settings to your + [.coleslawrc][config_file]. Plugin settings are described + below. Note that some plugins require additional setup. * Available plugins are listed below with usage descriptions and config examples. @@ -41,9 +41,9 @@ **Example**: `(incremental)` -**Setup**: -- You must run the `examples/dump_db.sh` script to generate a database dump - for your site before enabling the incremental plugin. +**Setup**: You must run the `examples/dump_db.sh` script to + generate a database dump for your site before enabling the + incremental plugin. ## LaTeX via Mathjax @@ -144,6 +144,16 @@ CL-USER> (chirp:complete-authentication "4173325") # ``` +## Versioned Deploys + +**Description**: Originally, this was Coleslaw's only deploy behavior. + Instead of deploying directly to `:deploy-dir`, creates `.curr` and + `.prev` symlinks in the *deploy-dir*, which point to timestamped + directories of the last two deploys of the site. Deploys prior to the + last two are automatically cleaned up. + +**Example**: `(versioned)` + ## Wordpress Importer **NOTE**: This plugin really should be rewritten to act as a diff --git a/plugins/versioned.lisp b/plugins/versioned.lisp index cbd781f..4818318 100644 --- a/plugins/versioned.lisp +++ b/plugins/versioned.lisp @@ -20,3 +20,5 @@ (when (probe-file curr) (update-symlink prev (truename curr))) (update-symlink curr new-build))) + +(defun enable ())