This is an automated email from the ASF dual-hosted git repository.
sebb 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 91340acd Remove unneeded trailing whitespace (#186)
91340acd is described below
commit 91340acd1811ff496ca8ea19d249958e00457ae4
Author: John Bampton <[email protected]>
AuthorDate: Sat Feb 18 18:32:00 2023 +1000
Remove unneeded trailing whitespace (#186)
---
CONFIGURE.md | 8 ++--
DEPLOYMENT.md | 26 +++++------
DEVELOPMENT.md | 108 ++++++++++++++++++++++-----------------------
MACOS.md | 20 ++++-----
README.md | 56 +++++++++++------------
www/board/agenda/README.md | 2 +-
www/roster/README | 24 +++++-----
www/roster/package.json | 2 +-
www/status/README.md | 4 +-
www/test/dataflow.json | 6 +--
10 files changed, 128 insertions(+), 128 deletions(-)
diff --git a/CONFIGURE.md b/CONFIGURE.md
index 1c7cde61..05820803 100644
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -45,13 +45,13 @@ Whimsy can be run on a client or in a local container for
development use.
* **Development setup instructions** are in [DEVELOPMENT.md](DEVELOPMENT.md)
and [MACOS.md](MACOS.md).
* **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
+
+* **Tool-specific configurations** can be found in config/ directory
## Production Server Configuration
-See [DEPLOYMENT.md](DEPLOYMENT.md) for full details. We use Puppet to
-provision the production VM with the basic dependencies as well as the
+See [DEPLOYMENT.md](DEPLOYMENT.md) for full details. We use Puppet to
+provision the production VM with the basic dependencies as well as the
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.
diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md
index 87b22ab7..3ef3a395 100644
--- a/DEPLOYMENT.md
+++ b/DEPLOYMENT.md
@@ -4,11 +4,11 @@ Deploying Production Whimsy.apache.org
The production `whimsy.apache.org` server is managed by [Puppet](puppetnode),
and
is automatically updated whenever commits are made to the master branch
of this repository. Thus code changes here are reflected in the production
-server within a few minutes. In the event of a major server crash, the
+server within a few minutes. In the event of a major server crash, the
infra team simply re-deploys the whole VM from Puppet.
-**Committers:** please test changes to end-user critical scripts before
-committing to master!
+**Committers:** please test changes to end-user critical scripts before
+committing to master!
To deploy a completely _new_ whimsy VM, see [Manual Steps](#manual-steps).
@@ -31,8 +31,8 @@ How Production Is Updated
to define the 'whimsy-pubsub' service which runs
[tools/pubsub.rb](tools/pubsub.rb)
- pubsub.rb watches for any commits from the whimsy git repo at
gitbox.apache.org
- When it detects a change, it tells Puppet to update the VM as a whole
-- Puppet then updates various svn/git repositories, ensures required tools and
setup
- is done if there are other changes to dependencies, and when needed restarts
most
+- Puppet then updates various svn/git repositories, ensures required tools and
setup
+ is done if there are other changes to dependencies, and when needed restarts
most
services that might need a restart
- Puppet also does a `rake update` to update various gem or ruby settings
@@ -42,9 +42,9 @@ Thus, in less than 5 minutes from any git push, the server is
running the new co
Production Configuration
==========
-The Whimsy VM runs Ubuntu 20.04 and is fully managed by Puppet using
-the normal methods Apache infra uses for managing servers. Note however
-that management of Whimsy code and tools is a PMC responsibility.
+The Whimsy VM runs Ubuntu 20.04 and is fully managed by Puppet using
+the normal methods Apache infra uses for managing servers. Note however
+that management of Whimsy code and tools is a PMC responsibility.
<a name="puppetnode"></a>
The **puppet definition** is contained in the following files (these are
private files and need a login):
@@ -54,7 +54,7 @@ The **puppet definition** is contained in the following files
(these are private
*
https://github.com/apache/infrastructure-p6/tree/production/modules/vhosts_whimsy/lib/puppet/functions
(macro functions used above)
*
https://github.com/apache/infrastructure-p6/blob/production/modules/whimsy_server/manifests/init.pp
(Defines various tools and directories used in some tools)
-
+
*
https://github.com/apache/infrastructure-p6/blob/production/modules/whimsy_server/manifests/cronjobs.pp
(Cronjobs control when /public/*.json is built and code and mail updates)
*
https://github.com/apache/infrastructure-p6/blob/production/modules/whimsy_server/manifests/procmail.pp
@@ -63,10 +63,10 @@ Before pushing any changes here, understand the Apache
Infra puppet workflow and
*
https://cwiki.apache.org/confluence/display/INFRA/Git+workflow+for+infrastructure-puppet+repo
To understand the high-level workflow for puppet changes.
-
+
* https://github.com/apache/infrastructure-puppet-kitchen#readme
* addition to [Make modules
useable](https://github.com/apache/infrastructure-puppet-kitchen#make-modules-useable)
step:
-
+
rm -rf zmanda_asf
mkdir -p zmanda_asf/manifests
echo "class zmanda_asf::client (){}" >
zmanda_asf/manifests/client.pp
@@ -77,7 +77,7 @@ Before pushing any changes here, understand the Apache Infra
puppet workflow and
Manual Steps
------------
-The following additional steps are required to get a new Whimsy VM up
+The following additional steps are required to get a new Whimsy VM up
and running - these are only needed for a new deployment.
* Ensure that the IP address is static, and has been added to the list of
allowed mail relays
@@ -91,7 +91,7 @@ and running - these are only needed for a new deployment.
* `sudo systemctl status board-agenda-websocket.service` - this should show
the service is running and has been up for some while
* `curl localhost:34234` - should produce 'curl: (52) Empty reply from
server' or similar
* if curl replies with something else, check that the service is still
running (and has not just been restarted)
- * if the syslog contains a message of the form:
+ * if the syslog contains a message of the form:
'Sep 24 13:09:07 whimsy-vm6 ruby[3435205]: what(): Encryption not
available on this event-machine'
then it will be necessary to re-install the gem eventmachine
If the service still does not start, try stopping and starting it:
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 6533708c..5ffe5ac5 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -5,7 +5,7 @@ Whimsy is a set of independent tools and a common library which
typically will
need to access various ASF SVN directories and/or LDAP. To do development and
testing, you will need access to a machine on which you are willing to install
libraries which do things like access LDAP, XML parsing, ASF Subversion repos,
-composing mail and the like for full functionality.
+composing mail and the like for full functionality.
Contents :books:
-------
@@ -32,7 +32,7 @@ Contents :books:
Architecture Overview
========
-The core Whimsy code is split into model/view, plus a variety of
+The core Whimsy code is split into model/view, plus a variety of
tools, some of which use the model, and some completely independent.
1. [lib/whimsy/asf](lib/whimsy/asf) contains the "model", i.e., a set of
classes
@@ -55,14 +55,14 @@ tools, some of which use the model, and some completely
independent.
Directories containing Rack applications can be identified by the presence
of a file with the name of `config.ru`.
-3. [tools](tools) contains miscellaneous and testing tools, as well as
+3. [tools](tools) contains miscellaneous and testing tools, as well as
scripts that may generate intermediate data files.
-4. [config](config) contains some sample configuration data for
+4. [config](config) contains some sample configuration data for
installing various services needed.
-5. [www/roster/public\_\*](www/roster) contains a number of scripts run
- by cron jobs or manually that create various data files in
+5. [www/roster/public\_\*](www/roster) contains a number of scripts run
+ by cron jobs or manually that create various data files in
[www/public on the production instance](https://whimsy.apache.org/public/).
Setup Whimsy Locally
@@ -104,14 +104,14 @@ or read the [detailed macOS setup steps](MACOS.md).
svn co --depth=files https://svn.apache.org/repos/private/foundation
You can specify an alternate location for these directories by placing
- a YAML [configuration file](CONFIGURE.md) named `.whimsy` in your home
+ a YAML [configuration file](CONFIGURE.md) named `.whimsy` in your home
directory An minimal example (be sure to include the dashed lines!):
:svn:
- /home/rubys/svn/foundation
- /home/rubys/svn/committers
-
- See repository.yml for a full list of repos needed. Different tools
+
+ 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:
@@ -160,8 +160,8 @@ or read the [detailed macOS setup steps](MACOS.md).
`ruby examples/board.rb`
It should print out an HTML page with current board members.
- See comments in the `board.rb` file for running the script as a
- standalone server to view in a local web browser. This test script
+ See comments in the `board.rb` file for running the script as a
+ standalone server to view in a local web browser. This test script
verifies the environment used by many, but not all, Whimsy tools.
2. **Configure mail sending** :mailbox_with_mail: (_optional_):
@@ -200,8 +200,8 @@ Running Whimsy Applications :car:
If there is a `Gemfile` in the directory containing the script or application
you wish to run, dependencies needed for execution can be installed using the
-command `bundle install`. Similarly, if starting from scratch you
-may need `gem install rake`. Periodically if underlying gems like
+command `bundle install`. Similarly, if starting from scratch you
+may need `gem install rake`. Periodically if underlying gems like
wunderbar are updated, you may need `bundle update`.
See also [How To: Keep Your Local Environment
Updated](#how-to-keep-your-local-environment-updated)
@@ -237,7 +237,7 @@ Advanced Configuration
Setting things up so that the **entire** whimsy website is available as
a virtual host, complete with authentication:
-1. Install passenger by running either running
+1. Install passenger by running either running
`passenger-install-apache2-module` and following its instructions, or
by visiting
https://www.phusionpassenger.com/library/install/apache/install/oss/.
@@ -267,9 +267,9 @@ a virtual host, complete with authentication:
description "listen for changes to whimsy applications"
start on dbus SIGNAL=SessionNew
exec /srv/whimsy/tools/toucher
-
+
4. (Optional) Debug your local Whimsy web environment with two scripts:
-
+
localhost:port/test.cgi?debug
localhost:port/racktest
@@ -278,23 +278,23 @@ More details about the production Whimsy instance are in
[DEPLOYMENT.md](DEPLOYM
Documentation Standards
============
-As a collection of semi-independent tools, Whimsy has a number of
+As a collection of semi-independent tools, Whimsy has a number of
different ways to document code or functionality for users.
-- **RDoc for whimsy/asf module APIs** The Rakefile has an RDoc task that now
- processes the lib/whimsy/ directory, which can be run locally, and
+- **RDoc for whimsy/asf module APIs** The Rakefile has an RDoc task that now
+ processes the lib/whimsy/ directory, which can be run locally, and
is run automatically on the server into https://whimsy.apache.org/docs/api/
-
-- **End user instructions** are provided in many tools by defining a
- `PAGETITLE` and a `helpblock ->` which are put into a consistent place
- on the page for users when using whimsy/asf/themes. This information
- is also parsed to generate a committer-only
- [listing of useful Whimsy
tools](https://whimsy.apache.org/committers/tools).
-
-- **Data dependencies** and the flow of data between different Whimsy
+
+- **End user instructions** are provided in many tools by defining a
+ `PAGETITLE` and a `helpblock ->` which are put into a consistent place
+ on the page for users when using whimsy/asf/themes. This information
+ is also parsed to generate a committer-only
+ [listing of useful Whimsy tools](https://whimsy.apache.org/committers/tools).
+
+- **Data dependencies** and the flow of data between different Whimsy
processes and other websites are described in
[test/dataflow.cgi](https://whimsy.apache.org/test/dataflow.cgi)
-- **How-To for whimsy committers** are what you're reading right here
+- **How-To for whimsy committers** are what you're reading right here
in DEVELOPMENT.md and in DEPLOYMENT.md, CONFIGURE.md, MACOS.md
@@ -303,7 +303,7 @@ How To / FAQ :question:
### How To: Create A New Whimsy CGI
-The simplest way to create a new standalone tool is copy an existing .cgi.
+The simplest way to create a new standalone tool is copy an existing .cgi.
Important things to check:
- chmod 755 is likely needed
@@ -312,28 +312,28 @@ Important things to check:
### How To: Use New SVN or Git Directories
-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)
+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)
class to access files from Subversion on the server, then check:
- Default SVN checkout mappings: [repository.yml](repository.yml)
### How To: Keep Your Local Environment Updated
-`rake update git:pull svn:update` will crawl the tree, updating all
+`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
+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 directory.
### How To: Authenticate/Authorize Your Scripts
-User authentication for any CGI script is provided by the http server's
-LDAP module, and can be done by by adding the path to the CGI in the
+User authentication for any CGI script is provided by the http server's
+LDAP module, and can be done by by adding the path to the CGI in the
deployment descriptor for the server under the appropriate `authldap` realm:
https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/whimsy-vm4.apache.org.yaml#L127
@@ -345,7 +345,7 @@ http server, and verify that the user is a part of the most
inclusive group
(typically: committers). That is done as above in `authldap`.
The CGI scripts that need to do more specific authorization will need to
-check `ASF::Auth` in their code, and output a "Status: 401 Unauthorized"
+check `ASF::Auth` in their code, and output a "Status: 401 Unauthorized"
line if access to the tool is **not** permitted for the user.
```ruby
@@ -362,14 +362,14 @@ end
### How To: Add A New Mailing List-Id
-Whimsy can use ASF::Mail to view mailing lists locally by having the
+Whimsy can use ASF::Mail to view mailing lists locally by having the
server subscribe to the list.
-- Subscribe _listname_@whimsy-_server_vmname_.apache.org to the desired
+- Subscribe _listname_@whimsy-_server_vmname_.apache.org to the desired
mailing list (see also [Deployment instructions](DEPLOYMENT.md#manual-steps))
- Add your _listname_ to the `:apache_mailmap:` entry in
[puppet](https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/whimsy-vm4.apache.org.yaml#L63)
-- Note that tools/deliver.rb will dump all mail locally (it does not
- currently get cleaned out) where it can be used by ASF::Mail
+- Note that tools/deliver.rb will dump all mail locally (it does not
+ currently get cleaned out) where it can be used by ASF::Mail
### How To: Test Whimsy Library methods
@@ -395,7 +395,7 @@ Simple shell scripts can use the following:
$LOAD_PATH.unshift '/srv/whimsy/lib'
require 'whimsy/asf'
-Adjust the paths above if you have not installed code in the standard place
+Adjust the paths above if you have not installed code in the standard place
(or add a link from /srv/whimsy to your copy of the code)
### How To: Match Email Addresses To Committers
@@ -412,12 +412,12 @@ p person # -> nil or an ASF::Person object
### How To: Have A CGI Create either HTML or JSON Output
-Often times Whimsy CGIs display visualizations of JSON or other structured
-data that is generated from various other sources. It's handy to have
-one script both create the JSON (to checkin to /public, perhaps) as well
+Often times Whimsy CGIs display visualizations of JSON or other structured
+data that is generated from various other sources. It's handy to have
+one script both create the JSON (to checkin to /public, perhaps) as well
as display the data.
-One example of this is the [trademark listing script](www/brand/list.cgi),
+One example of this is the [trademark listing script](www/brand/list.cgi),
which explicitly checks the query string to determine which output to send.
```ruby
@@ -434,22 +434,22 @@ _html do
...etc.
```
-Scripts that don't do the query string check can still be forced to have
+Scripts that don't do the query string check can still be forced to have
wunderbar return the _json data instead of _html via curl:
curl -i -H "Accept: application/json" -u curcuru
https://whimsy.apache.org/members/private-script.cgi
-This will prompt for a password interactively, and then cause the
+This will prompt for a password interactively, and then cause the
script to return _json to curl.
Whimsy On Windows
=================
While some tools may work on Microsoft Windows, many don't currently.
-Alternatives for Windows include a Docker image, a custom Vagrant VM, and a
Kitchen/Puppet
-managed Vagrant VM (as the [live instance](DEPLOYMENT.md) does). The primary
advantage
-of using an image or a VM is isolation. The primary disadvantage is that
-you will need to install your SVN credentials there and arrange to either
+Alternatives for Windows include a Docker image, a custom Vagrant VM, and a
Kitchen/Puppet
+managed Vagrant VM (as the [live instance](DEPLOYMENT.md) does). The primary
advantage
+of using an image or a VM is isolation. The primary disadvantage is that
+you will need to install your SVN credentials there and arrange to either
duplicate or mount needed SVN directories.
Further Reading
diff --git a/MACOS.md b/MACOS.md
index 67aae19b..88e7dd43 100644
--- a/MACOS.md
+++ b/MACOS.md
@@ -7,8 +7,8 @@ common to many tools are included here, and additional steps
required for
specific tools are linked at the bottom of these instructions.
See also the general [DEVELOPMENT.md](./DEVELOPMENT.md) configuration notes.
-:dizzy: **New!** For a simpler way to setup a macOS machine, please
-check out the [setupmymac script](./SETUPMYMAC.md), which automates
+:dizzy: **New!** For a simpler way to setup a macOS machine, please
+check out the [setupmymac script](./SETUPMYMAC.md), which automates
configuring and keeping updated a local Whimsy instance.
Install Homebrew
@@ -47,7 +47,7 @@ ruby 2.6.3p62 (2019-04-16 revision 67580)
[universal.x86_64-darwin19]
```
You need at least version 2.4.1 to match the currently deployed Whimsy server.
-If you don't see 2.3.1 or later, run `hash -r` and try again. If you still
need
+If you don't see 2.3.1 or later, run `hash -r` and try again. If you still
need
to update your ruby, proceed using one of the common ruby version managers:
rbenv (known to work), or rvm.
@@ -58,7 +58,7 @@ $ brew install rbenv
$ cd /srv/whimsy && rbenv install
$ rbenv init
```
-Follow directions to ensure rbenv is setup in your shell(s), and double-check
your ruby version.
+Follow directions to ensure rbenv is setup in your shell(s), and double-check
your ruby version.
Note the PATH changes that `rbenv init -` configures; you'll need to duplicate
it in your httpd conf later.
To use this globally when invoked through rbenv shims, you can use `rbenv
global $VERSION` to set that where `$VERSION` is the version in
`/srv/whimsy/.ruby-version`.
[TODO: describe how to set .ruby-version]
@@ -107,7 +107,7 @@ Note: on Ubuntu, it looks as though the default is
```/usr/lib/node_modules```
Clone the Whimsy code
------------
-Depending on whether or not you have a GitHub account ([Apache committer
setup](https://gitbox.apache.org/)),
+Depending on whether or not you have a GitHub account ([Apache committer
setup](https://gitbox.apache.org/)),
use GitHub Desktop or run one of the following:
```
@@ -208,7 +208,7 @@ dn: uid=rubys,ou=people,dc=apache,dc=org
cn: Sam Ruby
```
-Notes:
+Notes:
* See DEVELOPMENT.md for more [LDAP configuration](DEVELOPMENT.md#ldapconfig).
* To pick up the latest code, the above needs to be run from the directory
@@ -400,11 +400,11 @@ sudo launchctl load -w
/Library/LaunchDaemons/org.apache.httpd.plist
```
N.B. Because of System Integrity Protection (SIP), it's not possible to edit
files under /System.
-So the change is made to a copy.
+So the change is made to a copy.
However the original location is baked into apachectl which is also protected
by SIP.
This means apachectl ignores the change.
A work-round for this is to create an updated copy of apachectl somewhere
further up the path.
-
+
Configure whimsy.local vhost
----------------------------
@@ -507,13 +507,13 @@ Create a `~/.whimsy` file, and add the following content:
Verify this works:
```
-$ ruby whimsy/tools/testmail.rb
+$ ruby whimsy/tools/testmail.rb
```
Note Gmail will just be used as a delivery mechanism, you can still
use a different address (such as your @apache.org email address) as
the *from* address. The `domain` above should match the host portion of
-the from address.
+the from address.
Should your Apache user id differ from your local user id, either specify your
ASF user id as the first parameter to the testmail.rb program, or set the USER
diff --git a/README.md b/README.md
index d93179f3..65057239 100644
--- a/README.md
+++ b/README.md
@@ -48,46 +48,46 @@ or [list of public
datafiles](https://whimsy.apache.org/test/dataflow.cgi) are a
and please join us on the [public #whimsy channel on
Slack](https://the-asf.slack.com/).
If you have an idea for a new Whimsy tool, [email
us](mailto:[email protected]?subject=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 many tools. The Whimsy server also supports direct access
+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 many 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
+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
+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
+**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
===================
-Whimsy is run in an Apache hosted VM with httpd, Rack, Ruby, and variety of
other tools
+Whimsy is run in an Apache hosted VM with httpd, Rack, Ruby, and variety of
other tools
that directly interface with various parts of Apache organizational records.
Details for each type of deployed tool or script:
* **Static content** Changes pushed to GitHub master will be
- automatically deployed - every commit triggers the puppet agent to
+ automatically deployed - every commit triggers the puppet agent to
do an update, which may take a few minutes. Note that this includes the
contents of scripts and applications too.
-
+
* **Repository checkouts/clones** An copy of a number of repositories
are updated every 10 minutes via a cron job. This is controlled
by [repository.yml](repository.yml). The whimsy VM is also subscribed
to board@ and scans those emails for commit messages and will update
the copy of `foundation/board` when commits happen.
-
+
* **CGI scripts** any dependencies listed in a `Gemfile` will
automatically be installed. A simple CGI:
@@ -105,7 +105,7 @@ Details for each type of deployed tool or script:
A sample rack application (two empty directories, and a one line file):
https://github.com/apache/whimsy/tree/master/www/racktest
-
+
https://whimsy.apache.org/racktest
Authentication requirements will also need to be two phase, like with CGI
@@ -113,19 +113,19 @@ Details for each type of deployed tool or script:
instead of at the application level making use of Rack middleware such as:
https://github.com/apache/whimsy/blob/master/lib/whimsy/asf/rack.rb#L56
-
+
* **Cron jobs** are managed by puppet. See [deployment](./DEPLOYMENT.md) for
more
information.
- * **NEW!** Node.js is being prototyped to improve the Board Agenda tool, stay
tuned.
-
- * **Generated JSON data** files are automatically generated into
- the [`/public`](https://whimsy.apache.org/public/) directory, to
- cache frequently used data for whimsy and other applications. These
+ * **NEW!** Node.js is being prototyped to improve the Board Agenda tool, stay
tuned.
+
+ * **Generated JSON data** files are automatically generated into
+ the [`/public`](https://whimsy.apache.org/public/) directory, to
+ cache frequently used data for whimsy and other applications. These
are usually run from a cron calling a www/roster/public_*.rb file.
- See also an [overview of data dependencies and
flow](https://whimsy.apache.org/test/dataflow.cgi).
-
- * **Data models** for many Whimsy tools are in `lib/whimsy/asf`, and
- most **views** for tools are stored in `www`. Note that Whimsy has
- a wide variety of sometimes unrelated tools, so not everything
+ See also an [overview of data dependencies and
flow](https://whimsy.apache.org/test/dataflow.cgi).
+
+ * **Data models** for many Whimsy tools are in `lib/whimsy/asf`, and
+ most **views** for tools are stored in `www`. Note that Whimsy has
+ a wide variety of sometimes unrelated tools, so not everything
here uses the same models.
diff --git a/www/board/agenda/README.md b/www/board/agenda/README.md
index 6186d184..71dbfa1a 100644
--- a/www/board/agenda/README.md
+++ b/www/board/agenda/README.md
@@ -421,7 +421,7 @@ Nothing is perfect. Here are a few things to watch out for:
which includes methods like `File.read` and `YAML.parse`. On the client,
Ruby code is translated to JavaScript which only has access to JavaScript
libraries, which includes methods like `history.pushState` and
- `JSON.stringify`.
+ `JSON.stringify`.
[Ruby2JS filters](https://github.com/rubys/ruby2js#filters) reduce this
gap by converting many common Ruby methods calls to JavaScript equivalents
diff --git a/www/roster/README b/www/roster/README
index 90b302ac..9729e8c5 100644
--- a/www/roster/README
+++ b/www/roster/README
@@ -1,13 +1,13 @@
-This Whimsy Roster tool presents a variety of organizational data about
-people and groups at the ASF in a convenient and secure manner.
-It uses Rack and Sinatra to run the server, Wunderbar for output, and
-the whimsy/asf library to directly access a variety of ASF data
+This Whimsy Roster tool presents a variety of organizational data about
+people and groups at the ASF in a convenient and secure manner.
+It uses Rack and Sinatra to run the server, Wunderbar for output, and
+the whimsy/asf library to directly access a variety of ASF data
sources and files.
A public-facing version of some of this data is here:
https://whimsy.apache.org/foundation/orgchart/
-Note that public_*.rb scripts are run by cron on the whimsy.a.o
+Note that public_*.rb scripts are run by cron on the whimsy.a.o
server and control generating the /public/*.json files.
Run Roster Locally :car:
@@ -31,19 +31,19 @@ Issues? [Local
setup](../../DEVELOPMENT.md#running-whimsy-applications-car).
Architecture Overview
===
-The roster tool primarily displays data from a variety of sources
-(private and public), and in some cases allows self-service for
+The roster tool primarily displays data from a variety of sources
+(private and public), and in some cases allows self-service for
Apache committers to update data directly.
* config.ru and main.rb are the startup and central control.
-* models/ obviously provide the data models; many of them mirror but
+* models/ obviously provide the data models; many of them mirror but
add functionality to some of the whimsy/asf models.
-
-* views/ provide the individual view pages.html.rb and (when used)
+
+* views/ provide the individual view pages.html.rb and (when used)
associated pages.js.rb scripts that make interactive features work,
using React.js.
-* lib/whimsy/asf/auth is used by a few tools to do specific authorization
- steps **within** the tool - instead of simply relying on httpd
+* lib/whimsy/asf/auth is used by a few tools to do specific authorization
+ steps **within** the tool - instead of simply relying on httpd
to gate access to a URL as a whole.
\ No newline at end of file
diff --git a/www/roster/package.json b/www/roster/package.json
index 27cc791b..166624ab 100644
--- a/www/roster/package.json
+++ b/www/roster/package.json
@@ -3,7 +3,7 @@
"version": "0.1.0",
"repository": {
- "type": "svn",
+ "type": "svn",
"url":
"https://svn.apache.org/repos/infra/infrastructure/trunk/projects/whimsy/www/test/roster";
},
diff --git a/www/status/README.md b/www/status/README.md
index 7c83e3d8..bd89640a 100644
--- a/www/status/README.md
+++ b/www/status/README.md
@@ -54,7 +54,7 @@ anchor id for the element for linking purposes).
Internally, exceptions returned by a monitor are converted to a leaf node with
a name of `exception`, a title containing the exception, and data consisting
-of a stack traceback.
+of a stack traceback.
Href
----
@@ -114,7 +114,7 @@ The Apache Software Foundation infrastructure team uses
status. A dozen+ servers around the world check status regularly,
and will report failure results to the infrastructure
[Slack](https://the-asf.slack.com/) channel. _Important:_ The Infrastructure
-team ensures the underlying VM is up; the Whimsy PMC is responsible for
+team ensures the underlying VM is up; the Whimsy PMC is responsible for
the server software running inside the VM.
There are currently two Nodeping checks:
diff --git a/www/test/dataflow.json b/www/test/dataflow.json
index 23c2918a..cac408a4 100644
--- a/www/test/dataflow.json
+++ b/www/test/dataflow.json
@@ -156,8 +156,8 @@
"description": "ASF::ICLA: Tracks ICLAs and names; See also ASF::Person",
"maintainer": "vp-whimsy",
"sources": [
- "private/foundation/officers/iclas.txt",
- "*reserved-ids.yml",
+ "private/foundation/officers/iclas.txt",
+ "*reserved-ids.yml",
"*historic/committers.json"
]
},
@@ -165,7 +165,7 @@
"description": "ASF::LDAP: See also ASF::Config, Person, Member, Group",
"maintainer": "vp-whimsy",
"sources": [
- "ASF::LDAP::HOSTS",
+ "ASF::LDAP::HOSTS",
"apache/infrastructure-puppet/deployment/data/common.yaml"
]
},
