whimsical-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From curc...@apache.org
Subject [whimsy] branch master updated: Doc clarifications
Date Tue, 25 Apr 2017 23:41:49 GMT
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  80afe31   Doc clarifications
80afe31 is described below

commit 80afe314f570f3fc90afd08e1182f25415bbeb1f
Author: Shane Curcuru <asf@shanecurcuru.org>
AuthorDate: Tue Apr 25 19:41:45 2017 -0400

    Doc clarifications
---
 CONFIGURE.md  | 10 +++++-----
 DEPLOYMENT.md | 24 ++++++++++++------------
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/CONFIGURE.md b/CONFIGURE.md
index a80029b..177ea68 100644
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -23,9 +23,9 @@ run either in a local environment or with a webserver.
 
 Whimsy can be run on a client or in a local container for development use.
 
-* **App-wide default settings** are stored in a YAML formatted 
+* **App-wide default settings** are stored in a local YAML formatted 
   `~/.whimsy` file, notably including an `svn` pointer to where various 
-  local repo checkouts live as well as `sendmail` config (if used).  
+  local repo checkouts live as well as `sendmail` config (if used). 
   See also `lib/whimsy/asf/config.rb`
   
 * **LDAP configuration** will be stored in `/etc/(ldap|openldap)/ldap.conf`
@@ -39,9 +39,9 @@ Whimsy can be run on a client or in a local container for development use.
 * **Log files and debugging** are typically found in `/var/log/apache2/whimsy_error.log`

   and `/var/log/apache2/error_log`
   
-* **Development setup instructions** are in [DEVELOPMENT.md](DEVELOPMENT.md) and [MACOSX.md](DEVELOPMENT.md).
+* **Development setup instructions** are in [DEVELOPMENT.md](DEVELOPMENT.md) and [MACOSX.md](MACOSX.md).
 
-* **whimsy-asf Gem** is a set of the core whimsy model as a normal Gem: [asf.gemspec](asf.gemspec)
+* **whimsy-asf Gem** is a set of the core lib/whimsy/asf model as a normal Gem: [asf.gemspec](asf.gemspec)
   
 * **Tool-specific configurations** can be found in config/ directory  
 
@@ -53,4 +53,4 @@ Whimsy code.  A number of configuration steps ensure the production instance
 has access to LDAP, SVN repositories (some read/write), local mail
 sending and receiving/subscriptions.
 
-**Log files** are LDAP secured to Members in: https://whimsy.apache.org/members/log/
+* **Log files** are LDAP secured to Members in: https://whimsy.apache.org/members/log/
diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md
index d872bf8..ff38a7b 100644
--- a/DEPLOYMENT.md
+++ b/DEPLOYMENT.md
@@ -5,6 +5,15 @@ The contents of this repository are automatically deployed to the production
 https://whimsy.apache.org/ VM every 30 minutes - so be sure to test 
 your changes before pushing to master.
 
+Configuration Locations
+----
+Application developers may need to know where different things are configured:
+
+- Most **httpd config** is in the puppet definition whimsy-vm*.apache.org.yaml (below)
+- **SVN / git** updaters are in [repository.yml](repository.yml)
+- **Public JSON** generation comes from tools and controlled by whimsy_server/manifests/cronjobs.pp
+- **LDAP** configured in whimsy-vm*.apache.org.yaml
+
 Production Configuration
 ==========
 
@@ -15,11 +24,11 @@ that management of Whimsy is a PMC responsibility.
 <a name="puppetnode"></a>
 The **puppet definition** is contained in the following files:
 
- * https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/whimsy-vm3.apache.org.yaml
+ * https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/whimsy-vm3.apache.org.yaml
(Includes modules, software, vhosts, ldap realms, and httpd.conf)
 
- * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/whimsy_server/manifests/init.pp
+ * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/whimsy_server/manifests/init.pp
(Defines various tools and directories used in some tools)
 
- * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/whimsy_server/manifests/cronjobs.pp
+ * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/whimsy_server/manifests/cronjobs.pp
(Cronjobs control when /public/*.json is built and code and mail updates)
 
  * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/whimsy_server/manifests/procmail.pp
 
@@ -38,15 +47,6 @@ Before pushing any changes here, understand the Apache Infra puppet workflow
and
  * https://github.com/apache/infrastructure-puppet/blob/deployment/modules/vhosts_whimsy/README.md
    This details the changes to default puppet we use for Whimsy.
 
-Configuration Locations
-----
-Application developers may need to know where different things are configured:
-
-- Much of the server config is in the puppet definition whimsy-vm3.apache.org.yaml
-- SVN updaters are in [repository.yml](repository.yml)
-- Public JSON generation comes from tools and controlled by whimsy_server/manifests/cronjobs.pp
-- 
-
 Manual Steps
 ------------
 

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

Mime
View raw message