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 00759ff Add how to get involved section and update done todos
00759ff is described below
commit 00759ff7ec075693685d643d5c73442164d1c1fa
Author: Shane Curcuru <[email protected]>
AuthorDate: Wed Jun 7 10:47:09 2017 -0400
Add how to get involved section and update done todos
---
README.md | 30 ++++++++++++++++++++++++++++++
TODOS.md | 39 ++++++++++++++++++++++++---------------
2 files changed, 54 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 5df62aa..7d3665a 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,36 @@ and now also mirrored for Apache committers at:
* [Dependency Listing](./CONFIGURE.md#Dependencies)
* [Todos](TODOS.md).
+How To Get Involved!
+===============
+
+Since Whimsy hosts many independent tools that make finding or updating
information
+at the ASF simpler, there are plenty of places for Apache committers to
+get involved. Bugs or improvement suggestions for the many
+[tools available on Whimsy](https://whimsy.apache.org/committers/tools) are
always appreciated.
+
+If you have an idea for a new Whimsy tool, [email
us](mailto:[email protected]?subject=[IDEA] New tool idea)!
+The PMC supports a rich server environment, so deploying a new tool is as
+simple as proposing a .cgi with a bit of Ruby code. We also have deployments
+of Rack and Sinatra apps, and use JavaScript and Wunderbar for most of the
+UI building in most tools. The Whimsy server also supports direct access
+to Apache SVN or git repositories, making consuming data simple.
+
+The Whimsy committers are always looking for new ideas to improve processes
+at Apache, and we can either help you get started or suggest how to
+approach just about any sort of "find this ASF data and streamline that
+process" ideas.
+
+Most documentation is in the code or in the repo, and our dev@whimsical
+mailing list is active. Note that many Whimsy tools access committer- or
+member-private data, so some tools are access restricted.
+
+**Historical note:** The live production whimsy.apache.org server was used for
+the board agenda tool and more before we became the Apache Whimsy top level
+project. That's why [whimsy.apache.org](https://whimsy.apache.org/) is
+the production server, and mailing lists and a homepage are hosted
+on the [whimsical.apache.org](https://whimsical.apache.org/) domain.
+
Whimsy Architecture - Live Instance
===================
diff --git a/TODOS.md b/TODOS.md
index fe75a78..e223ee3 100644
--- a/TODOS.md
+++ b/TODOS.md
@@ -9,14 +9,6 @@ and crazy ideas alike. Comments appreciated.
## Core Improvements :round_pushpin:
-- [ ] Define core ASF style & header information in the model and
- implement in various applications.
[WHIMSY-81](https://issues.apache.org/jira/browse/WHIMSY-81)
-
-- [ ] Improve error handling in appropriate scripts to provide friendly
- user-visible cues on completion or stacktrace. [On Mailing
List](https://lists.apache.org/thread.html/a6743ba8e0132f865e2f43ea5eded30ad2bc81aeb2445973b8f89087@%3Cdev.whimsical.apache.org%3E)
-
-- [ ] Implement custom server error messages. (done for /www browse and roster
tool)
-
- [ ] Share common code for places where we jump thru hoops or regexes
to account for historical or file formats or odd PMC names.
@@ -26,19 +18,36 @@ and crazy ideas alike. Comments appreciated.
- [lib/whimsy/asf/mail.rb](lib/whimsy/asf/mail.rb) - maps mail list names
within Committee.mail_list
- [lib/whimsy/asf/podlings.rb](lib/whimsy/asf/podlings.rb) - maps mail
list names within *_mail_list
-- [ ] Show flow of data generated or consumed, tying back to the Role/Group
that maintains it.
- See json-editor branch (poorly named, I know)
+- [ ] Improve code sharing between www/roster and www/board with lib/whimsy,
+ as above regexes, and improving themes.rb use
+
+- [ ] Higher level documentation of various lib/whimsy/asf modules, so that
+ they and their associated output public/*.json files can be better
+ used across whimsy and other tools.
## Crazy Ideas :tada:
- [ ] Create templates for new applications and normalize behaviors of
existing applications to make a more consistent user experience.
-
-- [ ] Implement directory level index functionality to display a list
+
+## Done :checkered_flag:
+
+- [x] Define core ASF style & header information in the model and
+ implement in various applications.
[lib/whimsy/asf/themes.rb](lib/whimsy/asf/themes.rb)
+
+- [x] Improve error handling in appropriate scripts to provide friendly
+ user-visible cues on completion or stacktrace. Best practice to use
+ _body? in scripts and do complex operations inside that block:
+ then wunderbar will emit header and formatted error message for user.
+
+- [x] Implement custom server error messages. (done for /www browse and roster
tool)
+
+- [x] Show flow of data generated or consumed, tying back to the Role/Group
that maintains it.
+ [www/test/dataflow.cgi](https://whimsy.apache.org/test/dataflow.cgi)
+
+- [x] Implement directory level index functionality to display a list
of other available (and publishable) scripts there.
Scan curdir; forall *.cgi where second line includes WVisible, display
name/link.
Using a positive comment ensures only scripts wishing to be displayed
are visible.
- see tools/wwwdocs.rb
-
-
+ Effectively done as much is valuable:
[www/committers/tools](https://whimsy.apache.org/committers/tools)
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
