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 fafe8b0 dataflow.cgi can now (manually) generate public/README.html
fafe8b0 is described below
commit fafe8b094a2655eb64adc9b7dcf54f097b6780d6
Author: Shane Curcuru <[email protected]>
AuthorDate: Fri May 11 20:53:44 2018 -0400
dataflow.cgi can now (manually) generate public/README.html
Uses dataflow.json, so we only need to update one place of docs
---
www/public/README.html | 60 ++++++++++++++++++++++++++++----------------------
www/test/dataflow.cgi | 24 +++++++++++++++++---
2 files changed, 55 insertions(+), 29 deletions(-)
diff --git a/www/public/README.html b/www/public/README.html
index de1dc20..c309091 100644
--- a/www/public/README.html
+++ b/www/public/README.html
@@ -1,26 +1,34 @@
- <h2>Public JSON files</h2>
- <dl>
- <dt>committee-info.json</dt><dd>Committee (PMC) names and membership (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/committee-info.json";>documentation</a>)</dd>
- <dt>icla-info.json</dt><dd>Names of people who have submitted ICLAs who
have uids (committer accounts) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/icla-info.json";>documentation</a>)</dd>
- <dt>icla-info_noid.json</dt><dd>Names of people who have submitted ICLAs
who don't have uids. Either the ICLA has yet to be processed, or it was
submitted and not followed up. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/icla-info_noid.json";>documentation</a>)</dd>
- <dt>member-info.json</dt><dd>ASF member names (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/member-info.json";>documentation</a>)</dd>
- <dt>public_ldap_authgroups.json</dt><dd>Membership of LDAP auth groups.
Membership of an LDAP auth group is used to grant commit karma for sub-project
and other such resources (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_authgroups.json";>documentation</a>)</dd>
- <dt>public_ldap_committees.json</dt><dd>Membership of LDAP committee
groups. Membership of an LDAP committee group != membership of the PMC. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_committees.json";>documentation</a>)
- <br>
- <b>Will eventually be replaced by public_ldap_projects.json</b></dd>
- <dt>public_ldap_groups.json</dt><dd>Membership of LDAP unix groups.
Membership of an LDAP unix group is used to grant commit karma for that
project. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_groups.json";>documentation</a>)
- <br>
- <b>Will eventually be replaced by public_ldap_projects.json</b></dd></dd>
- <dt>public_ldap_people.json</dt><dd>Basic details of LDAP personal
entries. Shows the public name and whether the login is currently disabled. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_people.json";>documentation</a>)</dd>
- <dt>public_ldap_projects.json</dt><dd>Details of PMCs and Podlings. The
"owners" list holds the ids with (P)PMC karma, and the "members" list holds the
ids with (P)PMC committer karma. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_projects.json";>documentation</a>)
- <br>
- <b>Currently being introduced; will eventually replace
public_ldap_groups and public_ldap_committees</b></dd>
- <dt>public_ldap_services.json</dt><dd>Membership of LDAP service groups.
For example pmc_chairs shows the list of people with PMC chair karma (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_services.json";>documentation</a>)</dd>
- <dt>public_nonldap_groups.json</dt><dd>Membership of auth groups not
defined in LDAP. For example, podlings. (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_nonldap_groups.json";>documentation</a>)
- <br>
- <b>Podlings are being moved to public_ldap_projects.json, this file is
likely to become obsolete.</b>
- </dd>
- <dt>public_podling_status.json</dt><dd>Status of podlings: current,
graduated, retired (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_podling_status.json";>documentation</a>)</dd>
- <dt>public_podlings.json</dt><dd>podling details from
https://svn.apache.org/repos/asf/incubator/public/trunk/content/podlings.xml
(<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_podlings.json";>documentation</a>)</dd>
- <dt>site-scan.json</dt><dd>Data for Website link checks. (<a
href="/site/">documentation</a>)</dd>
- </dl>
+<h2>Public JSON files</h2><dl>
+<!-- DO NOT EDIT THIS FILE - manually regenerated editing dataflow.json and by
running: ruby www/test/dataflow.cgi -->
+<dt>committee-info.json</dt>
+ <dd>Committee (PMC) names and membership (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/committee-info.json";>docs</a>)</dd>
+<dt>icla-info.json</dt>
+ <dd>Names of people who have submitted ICLAs who have uids (committer
accounts) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/icla-info.json";>docs</a>)</dd>
+<dt>icla-info_noid.json</dt>
+ <dd>Names of people who have submitted ICLAs who don't (yet) have uids
(commiter accounts) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/icla-info_noid.json";>docs</a>)</dd>
+<dt>member-info.json</dt>
+ <dd>ASF Member name listing (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/member-info.json";>docs</a>)</dd>
+<dt>public_ldap_authgroups.json</dt>
+ <dd>Membership of LDAP auth groups. Membership of an LDAP auth group is used
to grant commit karma for sub-project and other resources (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_authgroups.json";>docs</a>)</dd>
+<dt>public_ldap_committees.json</dt>
+ <dd>Membership of LDAP committee groups. Note: Membership of an LDAP
committee group != membership of the PMC. (Will eventually be replaced by
public_ldap_projects.json) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_committees.json";>docs</a>)</dd>
+<dt>public_ldap_groups.json</dt>
+ <dd>Membership of LDAP unix groups. Membership of an LDAP unix group is used
to grant commit karma for a whole project. (Will eventually be replaced by
public_ldap_projects.json) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_groups.json";>docs</a>)</dd>
+<dt>public_ldap_people.json</dt>
+ <dd>Basic details of LDAP personal entries. Shows the public name and
whether the login is currently disabled (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_people.json";>docs</a>)</dd>
+<dt>public_ldap_projects.json</dt>
+ <dd>Details of PMCs and Podlings. The 'owners' list holds the ids with
(P)PMC karma, and the 'members' list holds the ids with (P)PMC committer karma.
(Currently being introduced; will eventually replace public_ldap_groups and
public_ldap_committees) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_projects.json";>docs</a>)</dd>
+<dt>public_ldap_services.json</dt>
+ <dd>Membership of LDAP service groups. For example pmc_chairs shows the list
of people with PMC chair karma (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_ldap_services.json";>docs</a>)</dd>
+<dt>public_nonldap_groups.json</dt>
+ <dd>Membership of auth groups not defined in LDAP. For example, Incubator
podlings. (Podlings are being moved to public_ldap_projects.json, this file is
likely to become obsolete) (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_nonldap_groups.json";>docs</a>)</dd>
+<dt>public_podling_status.json</dt>
+ <dd>Current Incubation status of each podling (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_podling_status.json";>docs</a>)</dd>
+<dt>public_podlings.json</dt>
+ <dd>Listings of podling data TODO? (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/public_podlings.json";>docs</a>)</dd>
+<dt>site-scan.json</dt>
+ <dd>Current status of project websites relating to required navigation links
(<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/site-scan.json";>docs</a>)</dd>
+<dt>pods-scan.json</dt>
+ <dd>Current status of Incubator podling websites relating to required
navigation links (<a
href="https://whimsy.apache.org/test/dataflow.cgi#https://whimsy.apache.org/public/pods-scan.json";>docs</a>)</dd>
+</dl><br/>For more information <a href="https://whimsy.apache.org/docs/";>see
API docs</a>
+and the <a
href="https://github.com/apache/whimsy/blob/master/DEPLOYMENT.md#configuration-locations";>public
JSON generator scripts</a>.
\ No newline at end of file
diff --git a/www/test/dataflow.cgi b/www/test/dataflow.cgi
index 64152f9..0a976f9 100755
--- a/www/test/dataflow.cgi
+++ b/www/test/dataflow.cgi
@@ -3,16 +3,34 @@ PAGETITLE = "Public Datafiles And Dependencies" #
Wvisible:tools data
$LOAD_PATH.unshift File.realpath(File.expand_path('../../../lib', __FILE__))
require 'json'
+
+# Command line use: emit replacement for www/public/README.html
+# Centralize maintenance of descriptions
+DATAFLOWDATA = '/Users/curcuru/src/g/whimsy/www/test/dataflow.json'
+DATAFLOWDOC = 'https://whimsy.apache.org/test/dataflow.cgi#'
+deplist = JSON.parse(File.read(DATAFLOWDATA))
+
+# Command line outputs to stdout raw HTML for README.html
+unless ENV['SCRIPT_NAME']
+ puts %Q|<h2>Public JSON files</h2><dl>|
+ puts %Q|<!-- DO NOT EDIT THIS FILE - manually regenerated editing
dataflow.json and by running: ruby www/test/dataflow.cgi -->|
+ deplist.each do |path, entry|
+ next if path !~ /whimsy.apache.org\/public/
+ puts %Q|<dt>#{File.basename(path)}</dt>|
+ puts %Q| <dd>#{entry['description']} (<a
href="#{DATAFLOWDOC}#{path}">docs</a>)</dd>|
+ end
+ puts %Q|</dl><br/>For more information <a
href="https://whimsy.apache.org/docs/";>see API docs</a>|
+ puts %Q|and the <a
href="https://github.com/apache/whimsy/blob/master/DEPLOYMENT.md#configuration-locations";>public
JSON generator scripts</a>.|
+ exit
+end
+
require 'whimsy/asf'
require 'wunderbar'
require 'wunderbar/bootstrap'
-
-DATAFLOWDATA = 'dataflow.json'
GITWHIMSY = 'https://github.com/apache/whimsy/blob/master'
_html do
_body? do
- deplist = JSON.parse(File.read(DATAFLOWDATA))
_whimsy_body(
title: PAGETITLE,
related: {
--
To stop receiving notification emails like this one, please contact
[email protected].
