Bug#492157: ITP: apollo -- The Apollo Solr Server
On Thu, Jul 24, 2008 at 07:24:22PM +1200, Paul wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Thanks for the feedback. Sometimes when one already knows what the
> package "is about" it seems plain that the description is absolutely
> clear as crystal. But it quite obviously is not!
Hi Paul, thanks for the quick reply, a few more comments are reported
below.
> The Apollo Solr Server is a debian packaging of Solr, the open source enterprise search engine which
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Drop this, it is a description of a Debian package, obviously we are
talking about Debian packaging, rather go for "Solr is the open source
enterprise search engine which ..."
> is available from the Apache project (http://lucene.apache.org/solr/). Solr is provided by the
As I told you, drop the homepage, it has no role in the long
description, rather use the Homepage field
(http://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Homepage)
> Apache project in the form of a tarball, which forms the upstream content of apollo. Apollo takes
> the tarball, unpacks it and then re-organises it along Debian-compliant lines with configuration
> files under /etc, logfiles under /var/log, data under /var/lib, start/stop scripts, and log rotation.
Drop this paragraph all together, these are packaging details, not
information useful for the sysadm which had to choose whether or not to
install Solr.
> Aside from this basic re-organisation, apollo also allows the user to easily configure the way Solr
> works via debconf, where the port Solr listens on, memory allocation and cron-driven replication
> settings can be chosen. With the latter, apollo allows easy setup of master-slave replication
> between a single master and one or more slave servers.
Most of this can be dropped as well, for similar reasons.
I suggest you to have a look at Developer's Reference 6.2.1
(http://www.debian.org/doc/developers-reference/best-pkging-practices.html#bpp-desc-basics)
to 6.2.4, it is full of useful hints on what should be part of
short/long descriptions and what shouldn't.
Hope this helps,
Cheers.
--
Stefano Zacchiroli -*- PhD in Computer Science \ PostDoc @ Univ. Paris 7
zack@{upsilon.cc,pps.jussieu.fr,debian.org} -<>- http://upsilon.cc/zack/
I'm still an SGML person,this newfangled /\ All one has to do is hit the
XML stuff is so ... simplistic -- Manoj \/ right keys at the right time
Reply to: