From f6760f702650422a08c71c38ff26bf93e805550d Mon Sep 17 00:00:00 2001 From: Chris Koeritz Date: Thu, 16 Nov 2017 09:30:39 -0500 Subject: [PATCH] lotso good docs mods --- .../feisty_meow_command_reference.txt | 136 ++++++++++++++++++ .../docs/manual/cakelampvm_guide_v002.html | 47 +++++- 2 files changed, 178 insertions(+), 5 deletions(-) create mode 100644 documentation/feisty_meow_command_reference.txt diff --git a/documentation/feisty_meow_command_reference.txt b/documentation/feisty_meow_command_reference.txt new file mode 100644 index 00000000..213e0694 --- /dev/null +++ b/documentation/feisty_meow_command_reference.txt @@ -0,0 +1,136 @@ + +These are the handiest commands available in the Feisty Meow scripts. + +setup and loading commands +========================== + ++ read "readme.txt" in the top of the feisty meow codebase, or ++ read it online at: https://feistymeow.org/feisty_meow/readme.txt + +revision control commands +========================= + +all revision control commands bring up the editor in the EDITOR environment +variable when creating commit messages. you need to actually save and quit +from that editor when you're done writing your commit message. + + here's a guide to writing good commit messages: + + https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message + +======== +the first suite of commands takes a list of directory names as parameters and +then operates on those names. +======== + + rgetem: + does a simple update (or pull) of the repository paths provided on the + command line. this will only get things from the main origin that the + repository is hooked up with, so it is super quick compared to the next + couple commands. + + rpuffer: + update the repositories provided on the command line by "puffing them out", + which means that the upstream repositories that feed the local one will be + synched up with it. this is quite important to do when a git repository has + multiple branches, since unmerged changes upstream can really snarl up your + checkin. this is basically a heavyweight version of rgetem. + + rcheckin: + checks in the list of repositories passed on the command line. in git + parlance, this adds all modified or untracked files, then commits all + changes in the repository, and finally pushes up the changes to the remote + online repository. before doing the checkin, this will do a full "rpuffer" + update on the repository to ensure that there are no unmerged upstream + changes that could cause problems later. + +======== +the next suite of commands uses the REPOSITORY_LIST environment variable as +the set of revision controlled folders to operate on. the feisty meow scripts +automatically add the feisty meow top-level (the apex) to this list to ensure +that updates are received when available. +======== + + getem: + update all repositories in the REPOSITORY_LIST from their upstream remote + counterparts. fast. + + puffer: + puffs out the REPOSITORY_LIST items to merge upstream changes. + + checkin: + checks in all changes in the REPOSITORY_LIST to their remote repositories. + +======== +some assorted other revision control commands: +======== + + feisty_branch: + shows the current branch that is checked out. + + this command will move your feisty meow codebase to the development branch: + pushd $FEISTY_MEOW_APEX; git checkout dev; popd + + and this command will get you back onto the mainline branch: + pushd $FEISTY_MEOW_APEX; git checkout master; popd + +============================= +the site avenger script suite +============================= + +the site avenger tools (inherited from the avbash project) are commands for +managing web sites. these scripts offer a lot of power to the developer, and +of course that comes with great responsibility... + +the site avenger scripts are configured by "app" files stored in the "config" +directory (in $FEISTY_MEOW_SCRIPTS/scripts/site_avenger/config). the scripts +seek out a config file named after the application, e.g. they look for +"winterportlibrary.app" if the application name is "winterportlibrary". +the basic config file "default.app" is used for any application that is unknown +in the config directory. any of the variable definitions provided in +default.app can be overridden to change how the applications, and associated +web site and domain, are configured. see "mapsdemo.app" for an example of +overriding the domain name for the mapsdemo application. + + revamp_cakelampvm: + establishes permissions and ownership to make the virtual machine and its + services behave properly. if something goes wonky, try running this script. + this script is also the main vehicle for delivering configuration changes + to the cakelampvm. we are trying really hard to never release a version 2 + of the vm, since we can patch it as needed using the revamp script. let's + see how well that works out... + + standup: + brings up an application or web site from scratch (potentially) by creating + an appropriate domain name, writing a basic apache site config file, pulling + the application from a git repository, and "powering up" the application via + composer. this is most powerful and effective on php sites, but can also be + used for other types of websites. note that this, and all of the scripts + here, are heavily biased for site avenger based development at saco designs. + to make these scripts truly your own, write configuration files (see above) + that define the proper folders and repository for your applications. + + teardown: + + + powerup + + avcoreup + siteup + sitepush + +satis-refresh + + + +lower level scripts used by site avenger scripts: + + add_domain / remove_domain: (from system script collection) + (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 + auto-generated domains.) + + add_apache_site / remove_apache_site: + + + diff --git a/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html b/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html index e04e007c..01063503 100644 --- a/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html +++ b/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html @@ -9,17 +9,54 @@ Configuration and Usage

By Chris Koeritz

Vintage: cakelampvm v002    - Updated: 2017-11-15

+ Updated: 2017-11-16 +

The cakelampvm project provides a virtualbox VM that acts as an "internet + in a bottle".  The virtual machine provides DNS services (bind9), a Web server (Apache2), a full Ubuntu Linux desktop environment, + the Fluxbox X window manager, + and a suite of tools called the Feisty Meow® codebase + + .  Together, these services provide you with a very flexible and + powerful testbed for web development, especially suited for CakePHP.

+

todo: arrange gritty details to back.

+

TOC GOES HERE.

-

Basic info for the guest VM

+

Guest VM Configuration

+

Powering up with the Feisty Meow® scripts

+

[First, let me drop the registered trademark symbol from here on + in.  I hope its presence above has been sufficiently clear for legal + purposes, but now it will just get in the way.  Also, capitalization + really bores me, and it's the feisty meow codebase anyhow, so that's how + it will be written henceforth.]

+

The feisty meow scripts are a cohesive bash scripting environment for + getting a variety of tasks done.  The scripts recently incorporated + the 'avbash' collection from Saco Designs, which provides tools for + bringing up CakePHP web sites and managing the collection of repositories + for those sites.  Each website is considered an "application", and + the application name itself (e.g. "winterportlibrary") can often provide + all the details for "powering up" the site.  The feisty meow team has + added additional scripts for managing DNS domains and Apache websites that + provide the capability to "stand up" an entire website around an + application, with accompanying domain.

+

The scripts for now are documented separately within the Feisty Meow + codebase.  The Feisty Meow readme file provides some valuable + information on configuring the codebase.  If you have the cakelampvm, + then this has already been done for you on the vm in the developer account.  + The script documentation is available in the UHHHHHH page of something..

How to set up virtualbox for your host PC

  1. Download and install virtualbox: -- 2.34.1