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: Retire SOFTWARE.md, fold into CONFIGURE
Date Tue, 25 Apr 2017 00:59:46 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  16df157   Retire SOFTWARE.md, fold into CONFIGURE
16df157 is described below

commit 16df157ef126035916091455a19c455b0739ebb3
Author: Shane Curcuru <asf@shanecurcuru.org>
AuthorDate: Mon Apr 24 20:59:42 2017 -0400

    Retire SOFTWARE.md, fold into CONFIGURE
---
 CONFIGURE.md | 17 ++++++++++++++++-
 README.md    |  6 +++---
 SOFTWARE.md  | 26 --------------------------
 3 files changed, 19 insertions(+), 30 deletions(-)

diff --git a/CONFIGURE.md b/CONFIGURE.md
index f6e4511..a80029b 100644
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -2,7 +2,22 @@
 
 As a collection of tools that directly access organizational data, 
 there are a number of places that you will need to configure to 
-have most of the code work as expected.
+have most of the code work as expected.  Whimsy Ruby code can 
+run either in a local environment or with a webserver.
+
+## Dependencies
+
+- Compilers & Servers
+  - Ruby 2.x.x (Production version: 2.3.)
+  - Apache HTTP Web Server 2.x
+  - Rack
+  - Phusion Passenger
+  - Puppet (for our [production](DEPLOYMENT.md) deployment)
+- A variety of Ruby gems
+  - [Wunderbar](https://github.com/rubys/wunderbar) - HTML Generator and CGI application
support
+  - [Ruby-ldap](https://github.com/bearded/ruby-ldap) - LDAP for Ruby
+  - [nokogiri](https://github.com/sparklemotion/nokogiri) - HTML parser for Ruby
+  - Full gem dependencies in `asf.gemspec`
 
 ## Local Clients / Development
 
diff --git a/README.md b/README.md
index 8122833..1183a6a 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@ Apache Whimsy Project Overview
 
 Apache Whimsy is a collection of useful organizational tools used by 
 the ASF and Apache committers to access and manipulate data about 
-Apache people, projects, and more.  Whimsy is both an Apache PMC, 
+Apache people, projects, and processes.  Whimsy is both an [Apache PMC](https://whimsical.apache.org/),

 this codebase, and the live deployed instance of https://whimsy.apache.org/.
 
 The ASF's Whimsy instance hosts static content, repository checkouts/clones, CGI scripts,
Rack
@@ -11,7 +11,7 @@ applications, tools, and cron jobs.  Note: features accessing private
 ASF data are restricted to committers, Members, or Officers of the ASF. 
 
 Every committer on the Whimsy PMC can both deploy changes and new
-applications to https://whimsy.apache.org/. 
+applications to https://whimsy.apache.org/ which is auto-deployed every 30 minutes. 
 
 How Tos and Get The Code
 ===============
@@ -28,7 +28,7 @@ and now also mirrored for Apache committers at:
  * [Configuration Pointers](./CONFIGURE.md)
  * [Monitoring How To](./www/status/README.md) - [Live Whimsy Status](https://whimsy.apache.org/status/)
  * [How To Setup on Mac OSX](./MACOSX.md)
- * [Dependency Listing](./SOFTWARE.md)
+ * [Dependency Listing](./CONFIGURE.md#Dependencies)
  * [Todos](TODOS.md).
 
 Whimsy Architecture - Live Instance
diff --git a/SOFTWARE.md b/SOFTWARE.md
deleted file mode 100644
index 148dfec..0000000
--- a/SOFTWARE.md
+++ /dev/null
@@ -1,26 +0,0 @@
-Whimsy runs atop a variety of software and configuration dependencies.
-This document is merely an overview, and is not necessarily complete.
-
-## Software Dependencies
-
-- Apache HTTP Web Server 2.x
-- Ruby 1.9.x
-- Rack
-- Phusion Passenger
-- Puppet (for our production deployment)
-
-A variety of Ruby gems:
-
-Wunderbar - HTML Generator and CGI application support
-Source: https://github.com/rubys/wunderbar
-Gem: wunderbar
-Module: wunderbar
-
-Ruby-ldap - LDAP for Ruby
-Source: https://github.com/bearded/ruby-ldap
-Gem: ruby-ldap
-Module: ldap
-
-nokogiri - HTML parser for Ruby
-
-Other Ruby gems as in `asf.gemspec`.

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

Mime
View raw message