You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@whimsical.apache.org by cu...@apache.org on 2017/06/10 23:04:53 UTC

[whimsy] branch master updated: Minor fixups; add simple data format description

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 b0d4775  Minor fixups; add simple data format description
b0d4775 is described below

commit b0d47757e16d16b3efc29bf4f64b5690b5d2c52d
Author: Shane Curcuru <as...@shanecurcuru.org>
AuthorDate: Sat Jun 10 19:04:48 2017 -0400

    Minor fixups; add simple data format description
---
 www/test/dataflow.cgi  | 18 +++++++++++++++---
 www/test/dataflow.json | 21 +++++++++++++++++++--
 2 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/www/test/dataflow.cgi b/www/test/dataflow.cgi
index e4a0b0d..eefd30b 100755
--- a/www/test/dataflow.cgi
+++ b/www/test/dataflow.cgi
@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-PAGETITLE = "Public Datafiles And Dependencies" # Wvisible:tools,data
+PAGETITLE = "Public Datafiles And Dependencies" # Wvisible:tools data
 
 $LOAD_PATH.unshift File.realpath(File.expand_path('../../../lib', __FILE__))
 require 'json'
@@ -35,6 +35,12 @@ _html do
             See the 
           }
           _a 'server docs for more info.', href: 'https://github.com/apache/whimsy/blob/master/DEPLOYMENT.md'
+          _ ' You can see the '
+          _a 'code for this script', href: "#{GITWHIMSY}/www#{ENV['SCRIPT_NAME']}"
+          _ ' the '
+          _a 'underlying data file', href: "#{GITWHIMSY}/www/#{DATAFLOWDATA}"
+          _ ' and see the '
+          _a 'key to this data.', href: "#datakey"
         end
       }
     ) do
@@ -49,7 +55,7 @@ _html do
             elsif dep =~ %r{\A/} then
               _code! do
                 _a! dep, href: "#{GITWHIMSY}#{dep}"
-              end              
+              end
             else
               _code! dep
             end
@@ -60,9 +66,14 @@ _html do
               _a.text_muted "#{info['maintainer']}", href: "#{GITWHIMSY}#{info['maintainer']}"
             else
               _span.text_muted 'Maintained by role/PMC: '
+              # TODO use a public lookup instead of committer-private roster tool
               _a.text_muted "#{info['maintainer']}", href: "https://whimsy.apache.org/roster/orgchart/#{info['maintainer']}"
             end
             _br
+            if info.key?('format') then
+              _span "Data structure: #{info['format']}"
+              _br
+            end
             if info.key?('sources') then
               _span 'Derived from:'
               _ul do
@@ -76,7 +87,8 @@ _html do
           end
         end
       end
-      _p do 
+      _p do
+        _a '', name: 'datakey'
         _ "The #{DATAFLOWDATA} file is currently a manually maintained file where the hash key identifies a file: "
         _ul do
           _li "Starting with 'http' means it's at a public URL"
diff --git a/www/test/dataflow.json b/www/test/dataflow.json
index a9d3d0c..a9c2a6c 100644
--- a/www/test/dataflow.json
+++ b/www/test/dataflow.json
@@ -1,6 +1,11 @@
 {
+  "https://whimsy.apache.org/test/dataflow.json": {
+    "description": "List of other public JSON and other data sources and underlying code models.",
+    "maintainer": "whimsy"
+  },
   "https://whimsy.apache.org/public/committee-info.json": {
     "description": "Committee (PMC) names and membership",
+    "format": "hash of hashes['committees']['accumulo']['display_name'] = 'Accumulo'",
     "maintainer": "/www/roster/public_committee_info.rb",
     "sources": [
       "/lib/whimsy/asf/committee.rb",
@@ -10,6 +15,7 @@
   },
   "https://whimsy.apache.org/public/icla-info.json": {
     "description": "Names of people who have submitted ICLAs who have uids (committer accounts)",
+    "format": "hash of hash['committers']['curcuru'] = 'Shane Curcuru'",
     "maintainer": "/www/roster/public_icla_info.rb",
     "sources": [
       "/lib/whimsy/asf/icla.rb"
@@ -17,6 +23,7 @@
   },
   "https://whimsy.apache.org/public/icla-info_noid.json": {
     "description": "Names of people who have submitted ICLAs who don't (yet) have uids (commiter accounts)",
+    "format": "hash of array['non_committers'][0] = 'NonCommitter Name'",
     "maintainer": "/www/roster/public_icla_info.rb",
     "sources": [
       "/lib/whimsy/asf/icla.rb"
@@ -24,6 +31,7 @@
   },
   "https://whimsy.apache.org/public/member-info.json": {
     "description": "ASF Member name listing",
+    "format": "hash of arrays['members'][0] = 'aadamchik' and hash['ex_members']['dion'] = 'Deceased Member (RIP)'",
     "maintainer": "/www/roster/public_member_info.rb",
     "sources": [
       "/lib/whimsy/asf/member.rb"
@@ -31,6 +39,7 @@
   },
   "https://whimsy.apache.org/public/public_ldap_authgroups.json": {
     "description": "Membership of LDAP auth groups. Membership of an LDAP auth group is used to grant commit karma for sub-project and other resources",
+    "format": "hash of hashes['auth']['apachecon']['roster'][11] = 'rbowen'",
     "maintainer": "/www/roster/public_ldap_authgroups.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -38,6 +47,7 @@
   },
   "https://whimsy.apache.org/public/public_ldap_committees.json": {
     "description": "Membership of LDAP committee groups. Note: Membership of an LDAP committee group != membership of the PMC",
+    "format": "hash of hashes['committees']['accumulo']['roster'][0] = 'acordova'",
     "maintainer": "/www/roster/public_ldap_committees.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -45,6 +55,7 @@
   },
   "https://whimsy.apache.org/public/public_ldap_groups.json": {
     "description": "Membership of LDAP unix groups. Membership of an LDAP unix group is used to grant commit karma for a whole project",
+    "format": "hash of hashes['groups']['accumulo']['roster'][0] = 'acordova'",
     "maintainer": "/www/roster/public_ldap_groups.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -52,6 +63,7 @@
   },
   "https://whimsy.apache.org/public/public_ldap_people.json": {
     "description": "Basic details of LDAP personal entries. Shows the public name and whether the login is currently disabled",
+    "format": "hash of hashes['people']['curcuru']['name'] = 'Shane Curcuru'",
     "maintainer": "/www/roster/public_ldap_people.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -59,6 +71,7 @@
   },
   "https://whimsy.apache.org/public/public_ldap_services.json": {
     "description": "Membership of LDAP service groups. For example pmc_chairs shows the list of people with PMC chair karma",
+    "format": "hash of hashes['services']['board']['roster'][1] = 'brett'",
     "maintainer": "/www/roster/public_ldap_services.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -66,6 +79,7 @@
   },
   "https://whimsy.apache.org/public/public_nonldap_groups.json": {
     "description": "Membership of auth groups not defined in LDAP. For example, Incubator podlings",
+    "format": "hash of hashes['groups']['blur']['roster'][0] = 'dblevins'",
     "maintainer": "/www/roster/public_nonldap_groups.rb",
     "sources": [
       "/lib/whimsy/asf/ldap.rb"
@@ -73,6 +87,7 @@
   },
   "https://whimsy.apache.org/public/public_podling_status.json": {
     "description": "Current Incubation status of each podling",
+    "format": "hash of hashes['podling']['abdera'] = 'graduated'",
     "maintainer": "/www/roster/public_podling_status.rb",
     "sources": [
       "/lib/whimsy/asf/podlings.rb"
@@ -80,6 +95,7 @@
   },
   "https://whimsy.apache.org/public/public_podlings.json": {
     "description": "Listings of podling data TODO?",
+    "format": "hash of hashes['podling']['abdera']['name'] = 'Abdera'",
     "maintainer": "/www/roster/public_podlings.rb",
     "sources": [
       "/lib/whimsy/asf/podlings.rb"
@@ -87,6 +103,7 @@
   },
   "https://whimsy.apache.org/public/site-scan.json": {
     "description": "Current status of project websites relating to required navigation links",
+    "format": "hash of hashes['accumulo']['display_name'] = 'Accumulo'",
     "maintainer": "/tools/site-scan.rb",
     "sources": [
       "https://www.apache.org/foundation/marks/pmcs"
@@ -124,7 +141,7 @@
     "maintainer": "whimsy",
     "sources": [
       "ASF::LDAP::HOSTS", 
-      "/apache/infrastructure-puppet/deployment/data/common.yaml"
+      "apache/infrastructure-puppet/deployment/data/common.yaml"
     ]
   },
   "/lib/whimsy/asf/mail.rb": {
@@ -209,7 +226,7 @@
     "description": "Historical data about past committer date changes",
     "maintainer": "whimsy"
   },
-  "/apache/infrastructure-puppet/deployment/data/common.yaml": {
+  "apache/infrastructure-puppet/deployment/data/common.yaml": {
     "description": "Core infrastructure data locations",
     "maintainer": "infra-staff"
   },

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