From dev-return-311-apmail-karaf-dev-archive=karaf.apache.org@karaf.apache.org Tue Oct 19 07:26:20 2010 Return-Path: Delivered-To: apmail-karaf-dev-archive@minotaur.apache.org Received: (qmail 26545 invoked from network); 19 Oct 2010 07:26:20 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 19 Oct 2010 07:26:20 -0000 Received: (qmail 7200 invoked by uid 500); 19 Oct 2010 07:26:20 -0000 Delivered-To: apmail-karaf-dev-archive@karaf.apache.org Received: (qmail 7179 invoked by uid 500); 19 Oct 2010 07:26:19 -0000 Mailing-List: contact dev-help@karaf.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@karaf.apache.org Delivered-To: mailing list dev@karaf.apache.org Received: (qmail 7171 invoked by uid 99); 19 Oct 2010 07:26:18 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Oct 2010 07:26:18 +0000 X-ASF-Spam-Status: No, hits=2.2 required=10.0 tests=FREEMAIL_FROM,HTML_MESSAGE,RCVD_IN_DNSWL_NONE,SPF_PASS,T_TO_NO_BRKTS_FREEMAIL X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of gnodet@gmail.com designates 74.125.82.176 as permitted sender) Received: from [74.125.82.176] (HELO mail-wy0-f176.google.com) (74.125.82.176) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Oct 2010 07:26:13 +0000 Received: by wyg36 with SMTP id 36so916094wyg.21 for ; Tue, 19 Oct 2010 00:25:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:received:in-reply-to :references:date:message-id:subject:from:to:content-type; bh=aHFs4+ruYjmml0gjc8fA/KJPVQ+4MCwgOj9tc2SCq48=; b=hTG4L0thcP9ZJ6wnPCJxqXL/1NAIkHxtlXtDVx/Fp9v0Ei1AQUa1Mz2K88ZWCNhtKl qKYqECnxA6OUOBxUW1Jb+6kgM/Kl1a5b0oyCpCvyX2BzIGMIqu1v+M8sBbSLOEKW4YsT h6fbzLj4k4IH0Lbsa+O7gPrF4Z4wtviLa0rds= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; b=mGknzDQYAKaylaFNBMObXgifQpI2PhgUF9zgC9snfBpLCmt/UTqolI22en0C3Zfomw dhwD8g9IKoLmyfcW/eSNZiHSPVKPdYDkdcvkZQ3Wj2Xb2wc0jNM7UAPetymA2U+A2omX i75UCdbt2c5VaVIV7pRgeoKw9BEP3ZsuFdlGI= MIME-Version: 1.0 Received: by 10.227.145.14 with SMTP id b14mr5925167wbv.24.1287473151788; Tue, 19 Oct 2010 00:25:51 -0700 (PDT) Received: by 10.227.134.14 with HTTP; Tue, 19 Oct 2010 00:25:51 -0700 (PDT) In-Reply-To: References: Date: Tue, 19 Oct 2010 09:25:51 +0200 Message-ID: Subject: Re: Manual using scalate now in svn From: Guillaume Nodet To: dev@karaf.apache.org Content-Type: multipart/alternative; boundary=0016365eea08dec6710492f33337 --0016365eea08dec6710492f33337 Content-Type: text/plain; charset=ISO-8859-1 I've updated the manual to use the same template / css than the web site, so that it looks way better now. That makes we think we deseperatly need a logo for Karaf ... On Mon, Oct 18, 2010 at 10:25, Guillaume Nodet wrote: > I've committed the project i've been working on github so far in the main > svn are, in trunk/documentation. > In order to keep that up-to-date with each version, I'd ask anyone to keep > it in sync when you modify / add a new feature in Karaf. > Note that this manual includes an auto-generated section containing all the > commands, so we could try to improve the help for those. > It can be done by adding the following attribute on the annotation as it's > done in the grep command > > @Command(...., detailedDescription="classpath:grep.txt") > > And then a file in > org/apache/karaf/shell/commands/grep.txt > The file is loaded from the command class (hence it's automatically > prefixed by the package name, unless an absolute uri is used). > > I guess we could try to auto-discover this file too btw. > > The manual is not fully complete and there are still sections to review / > fill, so feel free to have a look at those. > > Also, I'll try to publish a snapshot and have it linked from the main web > site and use it instead of the wiki based manuals, so that we'll have easier > versioning. > But we need to come up with a better design for the web pages and add a pdf > output. Help welcome! > > > -- > Cheers, > Guillaume Nodet > ------------------------ > Blog: http://gnodet.blogspot.com/ > ------------------------ > Open Source SOA > http://fusesource.com > > > -- Cheers, Guillaume Nodet ------------------------ Blog: http://gnodet.blogspot.com/ ------------------------ Open Source SOA http://fusesource.com --0016365eea08dec6710492f33337--