tweaks
authorChris Koeritz <fred@gruntose.com>
Thu, 16 Nov 2017 14:39:56 +0000 (09:39 -0500)
committerChris Koeritz <fred@gruntose.com>
Thu, 16 Nov 2017 14:39:56 +0000 (09:39 -0500)
documentation/feisty_meow_command_reference.txt

index 213e06947fbcd47aa740683b49cdabed39727b5a..5cbd70e302b24e64bd228701ac79a06592dc33e6 100644 (file)
@@ -1,5 +1,11 @@
 
+Welcome, adventurous script user.
+
 These are the handiest commands available in the Feisty Meow scripts.
+Note that each script is expected to be self-documenting.  Try running it
+with a "--help" flag (or with no parameters in some cases) to print the
+built-in docs.  At worst, you may have to read the script (documentation
+fail--please let us know).
 
 setup and loading commands
 ==========================
@@ -110,21 +116,39 @@ overriding the domain name for the mapsdemo application.
   that define the proper folders and repository for your applications.
 
   teardown:
+  takes down a site previously brought up by the standup command.  this just
+  eliminates the domain and the apache site though; the code is left in place
+  to prevent disaster.
   
+  powerup:
+  similar to standup, but just gets the application source out and powers it
+  up with composer.
+(note: automatic database configuration and inflation is in the pipeline but
+is not ready yet.  that will go into powerup.)
+  
+  avcoreup:
+  updates the avcore portion of a site avenger application.  this command can
+  accept an application name within which to update, or it can auto-pick the
+  applicatin for you from the available checked out ones in ~/apps (the default
+  storage folder for all site avenger style sites).
 
-  powerup
-
-  avcoreup
-  siteup
-  sitepush
+  siteup:
+  updates the entire checked out repository for a site avenger application.
+  supports app name on the command line, or auto-picks the app.
 
-satis-refresh
+  sitepush:
+  checks in the source code and other site assets for a site avenger app.
+  supports passing an app name on the command line, or auto-picks the app.
 
 
+  satis-refresh:
+  updates satis for a site(?).
+note: this is the one site avenger command that hasn't been "feisty meowicized" yet.
 
 lower level scripts used by site avenger scripts:
 
   add_domain / remove_domain: (from system script collection)
+  adds a DNS domain to the bind9 configuration.
   (the domain tools, for example, are
     very sensitive to edits within the chunks of code they have written.  if you
   need to edit bind config files, be sure to do it way above or way below the
@@ -132,5 +156,3 @@ lower level scripts used by site avenger scripts:
 
   add_apache_site / remove_apache_site:
 
-
-