en/glep/glep-0030.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!--
This HTML is auto-generated.  DO NOT EDIT THIS FILE!  If you are writing a new
PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
to templates.  DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
-->
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
  <title>GLEP 30 -- "Planet Gentoo" web log aggregator</title>
  <style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:date: $Date: 2006/10/10 20:25:14 $
:version: $Revision: 1.5 $
:copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the PEP HTML output of Docutils.
*/

.first {
  margin-top: 0 }

.last {
  margin-bottom: 0 }

.navigation {
  width: 100% ;
  background: #cc99ff ;
  margin-top: 0px ;
  margin-bottom: 0px }

.navigation .navicon {
  width: 150px ;
  height: 35px }

.navigation .textlinks {
  padding-left: 1em ;
  text-align: left }

.navigation td, .navigation th {
  padding-left: 0em ;
  padding-right: 0em ;
  vertical-align: middle }

.rfc2822 {
  margin-top: 0.5em ;
  margin-left: 0.5em ;
  margin-right: 0.5em ;
  margin-bottom: 0em }

.rfc2822 td {
  text-align: left }

.rfc2822 th.field-name {
  text-align: right ;
  font-family: sans-serif ;
  padding-right: 0.5em ;
  font-weight: bold ;
  margin-bottom: 0em }

a.toc-backref {
  text-decoration: none ;
  color: black }

body {
  margin: 0px ;
  margin-bottom: 1em ;
  padding: 0px }

dd {
  margin-bottom: 0.5em }

div.section {
  margin-left: 1em ;
  margin-right: 1em ;
  margin-bottom: 1.5em }

div.section div.section {
  margin-left: 0em ;
  margin-right: 0em ;
  margin-top: 1.5em }

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.attention, div.caution, div.danger, div.error, div.hint,
div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

div.hint p.admonition-title, div.important p.admonition-title,
div.note p.admonition-title, div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.figure {
  margin-left: 2em }

div.footer, div.header {
  font-size: smaller }

div.footer {
  margin-left: 1em ;
  margin-right: 1em }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1 {
  font-family: sans-serif ;
  font-size: large }

h2 {
  font-family: sans-serif ;
  font-size: medium }

h3 {
  font-family: sans-serif ;
  font-size: small }

h4 {
  font-family: sans-serif ;
  font-style: italic ;
  font-size: small }

h5 {
  font-family: sans-serif;
  font-size: x-small }

h6 {
  font-family: sans-serif;
  font-style: italic ;
  font-size: x-small }

.section hr {
  width: 75% }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.topic-title {
  font-family: sans-serif ;
  font-weight: bold }

pre.line-block {
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option-argument {
  font-style: italic }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

table {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

td, th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

td.num {
  text-align: right }

th.field-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap }

h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
  font-size: 100% }

tt {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body bgcolor="white">
<table class="navigation" cellpadding="0" cellspacing="0"
       width="100%" border="0">
<tr><td class="navicon" width="150" height="35">
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
 border="0" width="150" height="35" /></a></td>
<td class="textlinks" align="left">
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0030.txt">GLEP Source</a></b>]
</td></tr></table>
<table class="rfc2822 docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">30</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">&quot;Planet Gentoo&quot; web log aggregator</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
</tr>
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0030.txt?cvsroot=gentoo">2005/03/11 14:18:17</a></td>
</tr>
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Daniel Drake &lt;dsd&#32;&#97;t&#32;gentoo.org&gt;</td>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
</tr>
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">24-Oct-2004</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">25-Oct-2004, 10-Nov-2004, 11-Mar-2005</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#status" id="id21" name="id21">Status</a></li>
<li><a class="reference" href="#credits" id="id22" name="id22">Credits</a></li>
<li><a class="reference" href="#abstract" id="id23" name="id23">Abstract</a></li>
<li><a class="reference" href="#motivation" id="id24" name="id24">Motivation</a></li>
<li><a class="reference" href="#specification" id="id25" name="id25">Specification</a></li>
<li><a class="reference" href="#rationale" id="id26" name="id26">Rationale</a></li>
<li><a class="reference" href="#backwards-compatibility" id="id27" name="id27">Backwards Compatibility</a></li>
<li><a class="reference" href="#reference-implementation" id="id28" name="id28">Reference Implementation</a></li>
<li><a class="reference" href="#references" id="id29" name="id29">References</a></li>
<li><a class="reference" href="#copyright" id="id30" name="id30">Copyright</a></li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id21" id="status" name="status">Status</a></h1>
<p>The new <a class="reference" href="http://planet.gentoo.org/">Planet Gentoo</a> <a class="footnote-reference" href="#id1" id="id2" name="id2">[1]</a> came online 10-Mar-2005, so this GLEP is now Final.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id22" id="credits" name="credits">Credits</a></h1>
<ul class="simple">
<li><a class="reference" href="mailto:stuart&#64;gentoo.org">Stuart Herbert</a> <a class="footnote-reference" href="#id3" id="id4" name="id4">[2]</a> for the original idea</li>
<li><a class="reference" href="mailto:alexander&#64;gentoo.org">Alexander Plank</a> <a class="footnote-reference" href="#id5" id="id6" name="id6">[3]</a> who also has put effort into promoting this</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id23" id="abstract" name="abstract">Abstract</a></h1>
<p>This GLEP proposes the creation of &quot;Planet Gentoo&quot;, a new section of the
gentoo.org website.  It would aggregate weblogs (commonly known as &quot;blogs&quot;)
written by contributing Gentoo developers onto this single page, available to
the public.  I will refer to this new website section as &quot;the planet&quot; in this
GLEP.
We would also provide an installation of a weblog engine for developers that
do not currently have their own weblog.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id24" id="motivation" name="motivation">Motivation</a></h1>
<p>I'm trying to reduce the gap between the Gentoo user and development
communities.</p>
<p>Many large open source projects and software distributors have their own
Planet where contributors weblogs are aggregated.  See the <a class="reference" href="http://www.planetplanet.org">Planetplanet</a> <a class="footnote-reference" href="#id8" id="id9" name="id9">[4]</a>
homepage for a complete listing.  These other aggregations appear to be
successful and bring their relevant communities together.</p>
<p>These aggregations are often quite interesting to read, since they contain a
variation of topics, not all of which are related to the project.</p>
<p>The planet would add another method of user interaction with developers, as
most weblogs allow readers to post comments.</p>
<p>Readers would get more interested in the Gentoo project, and would get a feel
for the personalities of the contributing developers.  Although I am not
suggesting this should be used as an announcement tool, developers could also
use this to get general messages over to the user community.</p>
<p>This would also benefit our development, as developers would also be able to
keep track of what other developers are working on and promote more
collaboration amongst each other.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
<p>The proposed design is an installation of <a class="reference" href="http://www.planetplanet.org">Planetplanet</a> <a class="footnote-reference" href="#id8" id="id10" name="id10">[4]</a> at a part of the
gentoo.org infrastructure, e.g. <a class="reference" href="http://planet.gentoo.org">http://planet.gentoo.org</a></p>
<p>We would also provide an installation of <a class="reference" href="http://packages.gentoo.org/search/?sstring=wordpress">Wordpress</a> <a class="footnote-reference" href="#id12" id="id13" name="id13">[5]</a> or a similar weblogging
engine, for developers that do not have their own weblog or would wish to
move their log to an official Gentoo hosted website.  This could be provided
at (e.g.) <a class="reference" href="http://weblogs.gentoo.org">http://weblogs.gentoo.org</a></p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id26" id="rationale" name="rationale">Rationale</a></h1>
<p><a class="reference" href="http://www.planetplanet.org">Planetplanet</a> <a class="footnote-reference" href="#id8" id="id11" name="id11">[4]</a> is simply a weblog aggregator written in python.  It is
executed as a cronjob and fetches content from all the weblogs it has been
asked to, postprocesses and aggregates them into a single html file (based on
a template), and outputs that html content to an area provided by a webserver.
This should allow for ease of integration with any existing infrastructure.</p>
<p>Planetplanet is configurable through a single configuration file, which lists
the log feed URL, real name and user name for each contributing developer.</p>
<p><a class="reference" href="http://packages.gentoo.org/search/?sstring=wordpress">Wordpress</a> <a class="footnote-reference" href="#id12" id="id14" name="id14">[5]</a> is a weblogging engine written in PHP.  It relies on MySQL for
the data store.  After the initial setup, all configuration is done through a
web-based interface.</p>
<p>A group of people would be assigned the responsibility/CVS access to maintain
these two services.  I would suggest the existing infrastructure team to have
this responsibility.  If required, I will assist with the initial
configuration.</p>
<p>The planetplanet installation would fetch and aggregate developers weblogs
only, we would not accept non-developer logs.</p>
<p>Developers do not have to host their weblogs with us, practically all blogging
packages provide an XML feed (typically RSS) which planetplanet will happily
fetch and process.  Other feed formats are also accepted, examine the
planetplanet documentation for more info.
In the event of a contributing Gentoo developer leaving the project, their log
would be removed from the aggregation. If their log was hosted by ourselves,
it would be closed.  For this reason, some developers may choose to host their
log elsewhere - this is not a problem and is left to the decision of the
individual developers.</p>
<p>It is true that the addition of the planet to our website collection would add
yet another source of Gentoo information to our collection; our users and
developers are already overwhelmed with IRC, mailing lists, forums, and the
central website.  In contrast, a lot of information is currently replicated
over those mediums, but the planet would provide a taste of something new.
Developers can choose their own topics and are free to write about things that
perhaps would not fit into our existing communication mediums.  Additionally,
the planet will attempt to bring some existing content together by linking to
recent commits, bug lists, and dev.gentoo.org webspace for each contributing
developer.</p>
<p>It has been suggested that the activity of the planet may be an issue:
although a lot of activity would make the planet very successful, it may look
bad on us as a whole if the planet is inactive.</p>
<p><a class="reference" href="mailto:alexander&#64;gentoo.org">Alexander Plank</a> <a class="footnote-reference" href="#id5" id="id7" name="id7">[3]</a> started a <a class="reference" href="http://thread.gmane.org/gmane.linux.gentoo.devel/20480">gentoo-dev discussion</a> <a class="footnote-reference" href="#id15" id="id16" name="id16">[6]</a> back in August regarding
this exact idea.  Alexander set up a <a class="reference" href="http://penguincluster.com/cgi-bin/wiki.pl/BlogInterest">Planet Gentoo mini-survey</a> <a class="footnote-reference" href="#id17" id="id18" name="id18">[7]</a> to see which
developers have weblogs or would be interested in obtaining one to be
aggregated on the planet.  At the time of writing, the survey yielded a list
of 21 interested developers.</p>
<p>Looking at the other planets available, a contributor count like this would be
more than enough to keep the planet active and interesting.  Through my
experiments of finding developers existing weblogs through google and
aggregating them on my local Planetplanet installation, I have come to the
conclusion that just a small quantity of active weblogs is enough to keep the
planet going strongly.</p>
<p>I also note that the list of 21 interested developers was built up over a
short space of time, and it was only mentioned once in a rather large thread
on the gentoo-dev mailing list.  I predict that given more publicity amongst
the developers, this idea would be even more popular.  I also predict that if
such a planet were to go live, other developers would be motivated to join in,
and new developers joining the project would be keen on contributing.</p>
<p>The success of the planet will be evaluated by examining the number of hits to
the planet. 3 months after launch, one weeks worth of logs will be recorded,
and hits will be counted. If the hit count for that week is below 1000, the
planet will be deemed as not having met its target, and appropriate action can
be taken if the planet appears to be harming our image.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id27" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
<p>No issues.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id28" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
<p>See <a class="reference" href="http://bugs.gentoo.org/63160">Bug 63160</a> <a class="footnote-reference" href="#id19" id="id20" name="id20">[8]</a> for a template file mimicking the current gentoo.org design
plus a sample config file.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id29" id="references" name="references">References</a></h1>
<table class="docutils footnote" frame="void" id="id1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2" name="id1">[1]</a></td><td><a class="reference" href="http://planet.gentoo.org/">http://planet.gentoo.org/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4" name="id3">[2]</a></td><td><a class="reference" href="mailto:stuart&#64;gentoo.org">mailto:stuart&#64;gentoo.org</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id5">[3]</a></td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>)</em> <a class="reference" href="mailto:alexander&#64;gentoo.org">mailto:alexander&#64;gentoo.org</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id8">[4]</a></td><td><em>(<a class="fn-backref" href="#id9">1</a>, <a class="fn-backref" href="#id10">2</a>, <a class="fn-backref" href="#id11">3</a>)</em> <a class="reference" href="http://www.planetplanet.org">http://www.planetplanet.org</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id12" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a name="id12">[5]</a></td><td><em>(<a class="fn-backref" href="#id13">1</a>, <a class="fn-backref" href="#id14">2</a>)</em> <a class="reference" href="http://packages.gentoo.org/search/?sstring=wordpress">http://packages.gentoo.org/search/?sstring=wordpress</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id15" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id16" name="id15">[6]</a></td><td><a class="reference" href="http://thread.gmane.org/gmane.linux.gentoo.devel/20480">http://thread.gmane.org/gmane.linux.gentoo.devel/20480</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id17" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id18" name="id17">[7]</a></td><td><a class="reference" href="http://penguincluster.com/cgi-bin/wiki.pl/BlogInterest">http://penguincluster.com/cgi-bin/wiki.pl/BlogInterest</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id19" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id20" name="id19">[8]</a></td><td><a class="reference" href="http://bugs.gentoo.org/63160">http://bugs.gentoo.org/63160</a></td></tr>
</tbody>
</table>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id30" id="copyright" name="copyright">Copyright</a></h1>
<p>This document has been placed in the public domain.</p>
</div>

</div>
<div class="footer">
<hr class="footer" />
<a class="reference" href="glep-0030.txt">View document source</a>.
Generated on: 2006-10-10 20:23 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.

</div>
</body>
</html>