[116851] branches/gsoc11-statistics/stats-server

cal at macports.org cal at macports.org
Sat Feb 8 08:17:49 PST 2014


Revision: 116851
          https://trac.macports.org/changeset/116851
Author:   cal at macports.org
Date:     2014-02-08 08:17:48 -0800 (Sat, 08 Feb 2014)
Log Message:
-----------
macports stats: add FAQ and Credits

Modified Paths:
--------------
    branches/gsoc11-statistics/stats-server/config/routes.rb

Added Paths:
-----------
    branches/gsoc11-statistics/stats-server/app/controllers/static_controller.rb
    branches/gsoc11-statistics/stats-server/app/views/static/
    branches/gsoc11-statistics/stats-server/app/views/static/credits.html.erb
    branches/gsoc11-statistics/stats-server/app/views/static/faq.html.erb

Added: branches/gsoc11-statistics/stats-server/app/controllers/static_controller.rb
===================================================================
--- branches/gsoc11-statistics/stats-server/app/controllers/static_controller.rb	                        (rev 0)
+++ branches/gsoc11-statistics/stats-server/app/controllers/static_controller.rb	2014-02-08 16:17:48 UTC (rev 116851)
@@ -0,0 +1,2 @@
+class StaticController < ApplicationController
+end

Added: branches/gsoc11-statistics/stats-server/app/views/static/credits.html.erb
===================================================================
--- branches/gsoc11-statistics/stats-server/app/views/static/credits.html.erb	                        (rev 0)
+++ branches/gsoc11-statistics/stats-server/app/views/static/credits.html.erb	2014-02-08 16:17:48 UTC (rev 116851)
@@ -0,0 +1,24 @@
+<h2>Credits</h2>
+<p>
+	The MacPorts statistics web application and the initial client were written by <%= link_to "Derek Ingrouville", "https://trac.macports.org/wiki/derek" %>
+	when MacPorts participated in <%= link_to "Google Summer of Code 2011", "https://trac.macports.org/wiki/SummerOfCode2011" %>. Some documentation for the
+	source written in GSoC can be found in <%= link_to "the Wiki", "https://trac.macports.org/wiki/MacPortsStatisticsGSoC2011" %>. The source code for the
+	server is available in MacPorts' Subversion repository at <%= link_to "/branches/gsoc11-statistics", "https://trac.macports.org/browser/branches/gsoc11-statistics" %>.
+</p>
+<p>
+	The current installation of the statistics server has been modified and is run by MacPorts Developer <%= link_to "Clemens Lang", "https://trac.macports.org/wiki/cal" %>.
+</p>
+<p>
+	The client implementation as the <code>mpstats</code> port is the work of <%= link_to "Derek Ingrouville", "https://trac.macports.org/wiki/derek" %>,
+	<%= link_to "Joshua Root", "https://trac.macports.org/wiki/jmr" %> and <%= link_to "Clemens Lang", "https://trac.macports.org/wiki/cal" %>. The source of
+	the client is currently available at <%= link_to "/users/cal/ports/macports/mpstats", "http://trac.macports.org/browser/users/cal/ports/macports/mpstats" %>
+	in the MacPorts Subversion repository.
+</p>
+
+<h2>Source</h2>
+<p>Both the statistics client and the statistics server are open source:
+	<ul>
+		<li><%= link_to "client", "http://trac.macports.org/browser/users/cal/ports/macports/mpstats" %></li>
+		<li><%= link_to "server", "https://trac.macports.org/browser/branches/gsoc11-statistics" %></li>
+	</ul>
+</p>

Added: branches/gsoc11-statistics/stats-server/app/views/static/faq.html.erb
===================================================================
--- branches/gsoc11-statistics/stats-server/app/views/static/faq.html.erb	                        (rev 0)
+++ branches/gsoc11-statistics/stats-server/app/views/static/faq.html.erb	2014-02-08 16:17:48 UTC (rev 116851)
@@ -0,0 +1,63 @@
+<h2>Frequently Asked Questions</h2>
+
+<a name="collected-data"></a>
+<h3>Which Statistics Are Collected?</h3>
+<p>The MacPorts statistics collects and submits the following information to the server:</p>
+<ul>
+	<li>
+		<strong>A unique identifier for your MacPorts installation</strong><br />
+		This identifier is generated by <code>uuidgen</code> when you first
+		install the statistics service. We use this identifier to overwrite
+		statistics data you submitted earlier – we keep at most one set of
+		statistics per user per month. The identifier does not convey any
+		information about your system or location.
+	</li>
+	<li>
+		<strong>Version numbers and system properties</strong><br />
+		The statistics service collects and submits the versions of MacPorts,
+		OS X, GCC and Xcode installed on your system. It also tells us what
+		your CPU architecture, platform and build target architecture are.
+	</li>
+	<li>
+		<strong>A list of your installed ports</strong><br />
+		The statistics daemon collects and sends a list of the ports you have
+		installed containing the following information for each port:
+		<ul>
+			<li>name and installed version</li>
+			<li>whether the port is active or inactive</li>
+			<li>chosen variants</li>
+		</ul>
+	</li>
+</ul>
+
+<a name="collection-frequency"></a>
+<h3>How Often Are Statistics Sent?</h3>
+<p>The statistics daemon runs once a week, overwriting the data your
+installation did submit earlier in the same month, if any. If the daemon fails
+to send the data, the error is silently ignored.</p>
+
+<a name="why-statistics"></a>
+<h3>Why Do You Need Statistics?</h3>
+<p>We'd like to improve our understanding of how MacPorts and its ports are
+used. The statistics will help us determine which operating systems, build
+architectures and Xcode versions we need to support and test to provide
+a better overall experience for our users and less unexpected failures. The
+stats will also help us understand how quickly new MacPorts releases or port
+updates are adopted and how long we should wait before we can start using new
+features. The variant statistics will hopefully reveal ports where variants
+other than the default ones are popular choices and for which ports it might be
+advisable to test non-standard variants when updating a port, or even which
+variants should become defaults. We hope to use the variants data to build
+binary packages for non-default, but popular variants in the future.</p>
+
+<a name="opt-in"></a>
+<h3>How Can I Submit Statistics?</h3>
+<p>To start submitting statistics, install the <code>mpstats</code> port in
+your MacPorts installation.</p>
+
+<a name="opt-out"></a>
+<h3>How Do I Stop Submitting Statistics?</h3>
+<p>Uninstalling the <code>mpstats</code> port will prevent your system from
+submitting further statistics. Note that MacPorts will never default to
+submitting statistics. If you didn't explicitly <a href="#opt-in">opt-in</a>,
+MacPorts does not send statistics.</p>

Modified: branches/gsoc11-statistics/stats-server/config/routes.rb
===================================================================
--- branches/gsoc11-statistics/stats-server/config/routes.rb	2014-02-08 16:16:46 UTC (rev 116850)
+++ branches/gsoc11-statistics/stats-server/config/routes.rb	2014-02-08 16:17:48 UTC (rev 116851)
@@ -1,17 +1,13 @@
 StatsServer::Application.routes.draw do
-  
+
   get "home/index"
 
   resources :submissions
-
   resources :os_statistics
-  
   resources :installed_ports
-  
   resources :categories, :only => [:index] do
     match '/ports/page/:page', :to => 'ports#index', :page => :page
-    resources :ports, :only => [:index, :show] 
-      
+    resources :ports, :only => [:index, :show]
   end
 
   match '/ports/page/:page', :to => 'ports#index', :page => :page
@@ -19,7 +15,7 @@
   match '/ports/search', :to => 'ports#search_generate', :as => :search_generate
   match '/ports/search/:criteria/:val/page/:page', :to => 'ports#search', :criteria => :criteria, :val => :val, :page => :page
   match '/ports/search/:criteria/:val', :to => 'ports#search', :criteria => :criteria, :val => :val, :as => :search
-  
+
   root :to => 'home#index'
-  
+  match ':action' => 'static#:action'
 end
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140208/c5f14e74/attachment.html>


More information about the macports-changes mailing list