Excellent job. I would like to suggest that we use a different color or
font for the code / console screen. All the text is grey and does not
allow to make clear content separation.
On 21/10/10 17:45, Guillaume Nodet wrote:
I've deployed a snapshot of the karaf manual with the new styling, so it
should be available at in one hour or so (after the mirrors have been
updated):
http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
Let me know what you think.
On Tue, Oct 19, 2010 at 09:25, Guillaume Nodet<[email protected]> wrote:
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<[email protected]> 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
