harvest-dev team mailing list archive

[Daniel Holbach <daniel.holbach@xxxxxxxxxx>]

Daniel Holbach has proposed merging lp:~dholbach/harvest/581728 into lp:harvest.

Requested reviews:
  harvest-dev (harvest-dev)
Related bugs:
  #581728 add documentation about harvest and how to add stuff to it (and remove it)
  https://bugs.launchpad.net/bugs/581728

-- 
https://code.launchpad.net/~dholbach/harvest/581728/+merge/33418
Your team harvest-dev is requested to review the proposed merge of lp:~dholbach/harvest/581728 into lp:harvest.

=== modified file 'harvest/common/views.py'
--- harvest/common/views.py	2010-08-23 14:40:56 +0000
+++ harvest/common/views.py	2010-08-23 16:49:42 +0000
@@ -18,6 +18,9 @@
     return render_to_response('index.html', context,
                               context_instance=RequestContext(request))
 
+def doc(request):
+    return render_to_response('doc.html', {}, context_instance=RequestContext(request))
+
 def site_logout(request):
     logout(request)
     return HttpResponseRedirect('/')

=== modified file 'harvest/media/css/style.css'
--- harvest/media/css/style.css	2010-08-16 18:57:42 +0000
+++ harvest/media/css/style.css	2010-08-23 16:49:42 +0000
@@ -145,6 +145,10 @@
 	max-width:60em;
 }
 
+#content > .question {
+        font-style: italic;
+        font-weight: bold;
+}
 
 
 #filters {

=== added file 'harvest/templates/doc.html'
--- harvest/templates/doc.html	1970-01-01 00:00:00 +0000
+++ harvest/templates/doc.html	2010-08-23 16:49:42 +0000
@@ -0,0 +1,35 @@
+{% extends "base.html" %}
+
+{% load i18n %}
+
+{% block content %}
+<div class="main">
+<h1>HACKING Harvest</h1>
+<p>The code of harvest lives in <a href="https://code.launchpad.net/harvest";>Launchpad</a> and makes use of <a href="http://python.org/";>python</a> and <a href="http://www.djangoproject.com/";>Django</a>.</p>
+<p>Harvest regularly pulls data from URLs stored in the <tt>opportunities</tt> file in <a href="https://code.launchpad.net/harvest-data";>this branch</a>. The file layout is pretty simple.</p>
+<p>Before attempting to download the CSV (comma-separated values) file, Harvest will check the <tt>Last-Modified</tt> entry in the HTTP header and see if any modifications were made. This is done to reduce traffic.</p>
+<h2>Opportunities?</h2>
+<p>The <tt>opportunities</tt> file is in CSV and of the following format:</p>
+<pre>&lt;url&gt;,&lt;description&gt;</pre>
+<p>The URLs to CSV files must be reachable via HTTP(s). The <tt>description</tt> is optional.</p>
+<p>The CSV file in turn needs to be of the following form:</p>
+<pre>&lt;sourcepackage&gt;,&lt;url&gt;,&lt;description&gt;</pre>
+<p>For example:</p>
+<pre>vdrift,http://launchpad.net/bugs/106854,106854</pre>
+<p>Opportunities can be anything:</p>
+<ul>
+	<li>Easy bugs</li>
+	<li>Suitable Upstream patches</li>
+	<li>Patches of other distributions</li>
+	<li>Problems in the CD builds that should be fixed</li>
+	<li>etc.</li>
+</ul>
+<p>Let your imagination go wild. :-)</p>
+<h2>Setting it up</h2>
+<p>Just
+<ol>
+  <li><tt>bzr branch lp:harvest</tt></li>
+  <li><tt>less harvest/INSTALL</tt></li>
+</ol>
+</div>
+{% endblock %}

=== modified file 'harvest/templates/index.html'
--- harvest/templates/index.html	2010-08-23 14:40:56 +0000
+++ harvest/templates/index.html	2010-08-23 16:49:42 +0000
@@ -4,25 +4,41 @@
 
 {% block content %}
 
-<div class="mainpage">
-
+<div class="main">
 <h1>{% trans "Harvest" %}</h1>
 
-There is no landing page at the moment :(
-
-<p>
+<div id="aims">{% trans "Harvest's primary aims are:" %}
+<ul>
+        <li>{% trans "make it easy to find out about low-hanging fruit (opportunities)" %}</li>
+        <li>{% trans "aggregate the mass of TODO lists we use day to day" %}</li>
+        <li>{% trans "simplify work coordination" %}</li>
+</ul>
+</div>
+<div>
+<h2>Harvest FAQ</h2>
+<ul id="faq">
+  <li><span class="question">What can I do with Harvest?</span><br />
+    Harvest helps to identify both bugs that may be easy to address, and other package changes that are not yet bugs, but could improve the package.
+    Please take a look at the available opportunities when updating a package.</li>
+  <li><span class="question">Why is Harvest the way it is?</span><br />
+    Harvest is essentially based on one design-decision: let others do the hard work of assembling lists. Harvest knows just packages, lists and opportunities. It does not know what an open or fixed bug is or who upstream is.
+  </li>
+  <li><span class="question">What does "Mark reviewed" do?</span><br />
+    It will remove an opportunity from the front pages and only display it in a separate section on the page of the source package.
+    An obvious use-case for this is opportunities we have no control over, like Fedora patches.
+    By marking an opportunity as reviewed you will unclutter the main pages (in case it does not apply for us or you integrated it already).</li>
+  <li><span class="question">I think I found a bug - what do I do?</span><br />
+    If it's about the UI or the functionality of the page, please file it on <a href="https://bugs.launchpad.net/harvest/+filebug";>harvest</a>.
+    If it's about some piece of data that's on the harvest page, it's likely to be a bug in one of the scripts that fetches the data, please file it on <a href="https://bugs.launchpad.net/harvest-data/+filebug";>harvest-data</a> instead.
+    The <a href="doc/">HACKING Guide</a> has more information about that.</li>
+</ul>
+</div>
+<div id="stats">
 {% blocktrans count users as counter %}1 user, {% plural %}{{ counter }} users, {% endblocktrans %}&nbsp;
 {% blocktrans count sourcepackages as counter %}1 source package, {% plural %}{{ counter }} source packages, {% endblocktrans %}&nbsp;
 {% blocktrans count opportunities as counter %}1 opportunity, {% plural %}{{ counter }} opportunities, {% endblocktrans %}&nbsp;
 {% blocktrans count opportunitylists as counter %}1 opportunity list, {% plural %}{{ counter }} opportunity lists, {% endblocktrans %}&nbsp;
 {% blocktrans count notes as counter %}1 note.{% plural %}{{ counter }} notes.{% endblocktrans %}
-</p>
-
-{% if translator_credits %}
-<p class="footnote">
-{% trans "Translated by:" %} {{ translator_credits|join:", " }}
-</p>
-{% endif %}
-
+</div>
 </div>
 {% endblock %}

=== modified file 'harvest/urls.py'
--- harvest/urls.py	2010-08-23 14:15:29 +0000
+++ harvest/urls.py	2010-08-23 16:49:42 +0000
@@ -6,6 +6,7 @@
 
 urlpatterns = patterns('',
     url(r'^$', 'common.views.index', name='home'),
+    url(r'^doc/$', 'common.views.doc', name='doc'),
     url(r'^opportunities/', include('opportunities.urls')),
     url(r'^services/', include('services.urls')),
     url(r'^openid/', include('django_openid_auth.urls')),