Selaa lähdekoodia

Little more doc work, fix versioned plugin thinko.

Brit Butler 10 vuotta sitten
vanhempi
commit
b2082175e3
3 muutettua tiedostoa jossa 18 lisäystä ja 8 poistoa
  1. 0 2
      docs/hacking.md
  2. 16 6
      docs/plugin-use.md
  3. 2 0
      plugins/versioned.lisp

+ 0 - 2
docs/hacking.md

@@ -217,8 +217,6 @@ PAGE, a content type for static page support, is available as a plugin.
217 217
 
218 218
 ### TODO for 0.9.6
219 219
 
220
-* Finish docs updates to:
221
-  * plugin-use.md -> Incremental plugin, Versioned plugin. Twitter summary cards.
222 220
 * A real test suite with Stefil that at *least* tests:
223 221
   * `read-content`
224 222
   * `load-config`

+ 16 - 6
docs/plugin-use.md

@@ -1,8 +1,8 @@
1 1
 # General Use
2 2
 
3
-* Add a list with the plugin name and settings to the ```:plugins```
4
-  section of your [.coleslawrc][config_file]. Plugin settings are
5
-  described below.
3
+* To enable a plugin, add its name and settings to your
4
+  [.coleslawrc][config_file]. Plugin settings are described
5
+  below. Note that some plugins require additional setup.
6 6
 
7 7
 * Available plugins are listed below with usage descriptions and
8 8
   config examples.
@@ -41,9 +41,9 @@
41 41
 
42 42
 **Example**: `(incremental)`
43 43
 
44
-**Setup**:
45
-- You must run the `examples/dump_db.sh` script to generate a database dump
46
-  for your site before enabling the incremental plugin.
44
+**Setup**: You must run the `examples/dump_db.sh` script to
45
+  generate a database dump for your site before enabling the
46
+  incremental plugin.
47 47
 
48 48
 ## LaTeX via Mathjax
49 49
 
@@ -144,6 +144,16 @@ CL-USER> (chirp:complete-authentication "4173325")
144 144
 #<CHIRP-OBJECTS:USER PuercoPop #18405433>
145 145
 ```
146 146
 
147
+## Versioned Deploys
148
+
149
+**Description**: Originally, this was Coleslaw's only deploy behavior.
150
+  Instead of deploying directly to `:deploy-dir`, creates `.curr` and
151
+  `.prev` symlinks in the *deploy-dir*, which point to timestamped
152
+  directories of the last two deploys of the site. Deploys prior to the
153
+  last two are automatically cleaned up.
154
+
155
+**Example**: `(versioned)`
156
+
147 157
 ## Wordpress Importer
148 158
 
149 159
 **NOTE**: This plugin really should be rewritten to act as a

+ 2 - 0
plugins/versioned.lisp

@@ -20,3 +20,5 @@
20 20
     (when (probe-file curr)
21 21
       (update-symlink prev (truename curr)))
22 22
     (update-symlink curr new-build)))
23
+
24
+(defun enable ())