On 05/12/12 16:42, Sebastian Schaffert wrote:
2012/12/5 Fabian Christ <[email protected]>
2012/12/5 Sebastian Schaffert <[email protected]>
Regarding the website we have our designer already working on a logo,
and I
suggest we use "mvn site" to automatically generate it, because this will
already create a lot of documentation.
So you do not plan to use the Apache CMS [1] for the website? Or do you
plan to generate things from Maven for the Apache CMS?
It is just a question. I have no experience in generating complete websites
from Maven or how to combine it with the ASF CMS. Would be nice to see.
Many projects already do this. If the Maven "site" reporting is configured
properly in the Maven build file, this can generate very good and extensive
web pages for a project. The Maven site itself is a good example (
http://maven.apache.org/).
The advantage of this approach is that we would not need to maintain
documentation and source code separately, and it is easy to include
automatically generated documentation parts like the Javadoc, REST API,
License Report, or Developer Information in the web page.
So I would try going this approach. :-)
Greetings,
Sebastian
[1] http://www.apache.org/dev/cms.html
--
Fabian
http://twitter.com/fctwitt
</mentor>
The website has two distinct faces : inward to the project and it's
processes, and the maven plugins are good at doing this with reports,
but also outward to users for documentation and maven really does not do
much for that aspect in my experience.
In a separate site, there is some stuff that needs to be kept in step
with versions but, with careful writing, it's not very much.
The outward facing documentation, and I mean more than just javadoc,
often has a different lifecycle than the inward-looking project reports.
CMS is great for maintenance - read the website, see something to fix,
press "edit" and do it there and then in the browser. The bulk content
is markdown+tables.
It may be possible to combine - look at other projects and ask them if
they look interesting.
Jena uses CMS - we wanted a separate, designed information architecture,
one of the project members (Ian) was keen to do it that way and he did
the bulk of the work. It used HTML content converted to markdown.
Andy
A pro-maven link:
http://blog.akquinet.de/2012/04/12/maven-sites-reloaded/
