[whimsy] branch master updated: Add new or improved docs

[cu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

curcuru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git

The following commit(s) were added to refs/heads/master by this push:
       new  0dcd76d   Add new or improved docs
0dcd76d is described below

commit 0dcd76d55889d3ebbae25d2e35eefb5984f0c0e9
Author: Shane Curcuru <as...@shanecurcuru.org>
AuthorDate: Wed Apr 26 22:06:08 2017 -0400

    Add new or improved docs
---
 DEVELOPMENT.md | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index d6f9f97..10e700c 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -87,6 +87,9 @@ This section is for those desiring to run a whimsy tool on their own machine.
         :svn:
         - /home/rubys/svn/foundation
         - /home/rubys/svn/committers
+   
+   See repository.yml for a full list of repos needed.  Different tools 
+   require different local checkouts to function; some require git clone.
 
 4. **Configure LDAP** servers and certificates:
 <a name="ldapconfig"> </a>
@@ -243,9 +246,9 @@ Important things to check:
 - Double-check paths to the lib/asf files (which you will be using a lot)
 - Test locally first; in production logs are in [/members/log](https://whimsy.apache.org/members/log/)
 
-### How To: Use New SVN Directories
+### How To: Use New SVN or Git Directories
 
-Some SVN repos/files are checked out via cron jobs regularly for 
+Some SVN/Git repos/files are checked out via cron jobs regularly for 
 caching and read only access.  Some applications checkout needed files 
 just when running into temp dirs (typically to modify them and commit 
 changes).  If you have trouble using the existing [ASF::SVN classes](lib/whimsy/asf/svn.rb) 
@@ -253,6 +256,16 @@ class to access files from Subversion on the server, then check:
 
 - Default SVN checkouts: [repository.yml](repository.yml)
 
+### How To: Keep Your Local Environment Updated
+
+`rake update git:pull svn:update` will crawl the tree, updating all 
+gems as well as pulling/updating any existing git or svn checkouts that
+you have locally from repository.yml.
+
+Note also that sometimes you may need to `bundle exec *command*` instead 
+of just doing `bundle *command*`, since using the exec uses a subtly 
+different set of gem versions from the local director.
+
 Whimsy On Windows
 =================
 
@@ -270,7 +283,7 @@ The [board agenda](www/board/agenda) application
 is an eample of a complete tool that makes extensive use of the library
 factoring, has a suite of test cases, and client componentization (using
 ReactJS), and provides instructions for setting up both a Docker component and
-a Vagrant VM.
+a Vagrant VM.  There are [custom setup steps](config/board-agenda.md) to run it locally.
 
 If you would like to understand how the view code works, you can get started
 by looking at a few of the

-- 
To stop receiving notification emails like this one, please contact
['"commits@whimsical.apache.org" <co...@whimsical.apache.org>'].