Documentation changes to reflect new plugin assetlink stuff
authorChristopher Allan Webber <cwebber@dustycloud.org>
Thu, 23 May 2013 18:43:04 +0000 (13:43 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Thu, 23 May 2013 18:43:04 +0000 (13:43 -0500)
 - updated old theme assetlink section to reflect new location of
   ./bin/gmg assetlink and removed comment about the plugin command
   being temporary.
 - Added a new section to the standard config file on where to put the
   plugin_static section
 - Added release notes about said section

This commit sponsored by Thomas Webber.  Thanks, Dad!

docs/source/pluginwriter/api.rst
docs/source/siteadmin/deploying.rst
docs/source/siteadmin/relnotes.rst
docs/source/siteadmin/theming.rst

index 1cfd65d77ffa9b4f59f9627b8cd702a94dd25c25..06295c770f271dea204d117c2c454078746f58be 100644 (file)
@@ -149,13 +149,11 @@ passes back a PluginStatic object.
 Running plugin assetlink
 ++++++++++++++++++++++++
 
-.. TODO: Fix this command when it lands elsewhere ;)
-
 In order for your plugin assets to be properly served by MediaGoblin,
 your plugin's asset directory needs to be symlinked into the directory
 that plugin assets are served from.  To set this up, run::
 
-  ./bin/gmg theme assetlink
+  ./bin/gmg assetlink
 
 
 Using staticdirect
index 9bcc06371acef2d393122c6983a88383d8684be1..0ee6b5b40bee4164bba1fa823b9daedce05a4cef 100644 (file)
@@ -327,6 +327,11 @@ this ``nginx.conf`` file should be modeled on the following::
         alias /srv/mediagoblin.example.org/mediagoblin/user_dev/theme_static/;
      }
 
+     # Plugin static files (usually symlinked in)
+     location /plugin_static/ {
+        alias /srv/mediagoblin.example.org/mediagoblin/user_dev/plugin_static/;
+     }
+
      # Mounting MediaGoblin itself via FastCGI.
      location / {
         fastcgi_pass 127.0.0.1:26543;
index 5d342ef1bab73c59dbd45c330142f9db1abba0c5..d25771d3d479964d9001ebafe4168715659eed5e 100644 (file)
@@ -22,6 +22,21 @@ carefully, or at least skim over it.
 0.4.0
 =====
 
+**Do this to upgrade**
+1. Make sure to run ``bin/gmg dbupdate`` after upgrading.
+2. See "For Theme authors" if you have a custom theme.
+3. Note that ``./bin/gmg theme assetlink`` is now just
+   ``./bin/gmg assetlink`` and covers both plugins and assets.
+   Keep on reading to hear more about new plugin features.
+4. If you want to take advantage of new plugins that have statically
+   served assets, you are going to need to add the new "plugin_static"
+   section to your nginx config.  Basically the following for nginx::
+
+     # Plugin static files (usually symlinked in)
+     location /plugin_static/ {
+        alias /srv/mediagoblin.example.org/mediagoblin/user_dev/plugin_static/;
+     }
+
 **For theme authors**
 
 If you have your own theme or you have any "user modified templates",
@@ -34,6 +49,8 @@ please note the following:
   You can easily customize this to give a welcome page appropriate to
   your site.
 
+**New features**
+
 
 0.3.3
 =====
index 98ec6de7fc9dcf23b3400a30a2674acfb5731e48..11ae387586de12f353cdbea039241dafe8a2c12e 100644 (file)
@@ -51,7 +51,7 @@ want to install this theme!  Don't worry, it's fairly painless.
 
 5. Link the assets so that they can be served by your web server::
 
-       $ ./bin/gmg theme assetlink
+       $ ./bin/gmg assetlink
 
 .. Note::