You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by Roland Weber <os...@dubioso.net> on 2007/12/14 17:11:55 UTC

[DISCUSS] future web site structure

Hi folks,

since we'll be moving to our own website soonish,
let's discuss how we're going to structure it.
Erik suggested to copy over parts of the Jakarta
website such as the bylaws. I've taken a look to
identify which of the Jakarta pages may be useful
for us and do not have a corresponding page below
jakarta/httpcomponents/. I found

1. the download pages
http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpcore.cgi
http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpclient.cgi
http://jakarta.apache.org/site/downloads/downloads_commons-httpclient-3.x.cgi

2. Bylaws & Guidelines
http://jakarta.apache.org/site/management.html
http://jakarta.apache.org/site/guidelines.html
       + some referenced from guidelines.html
http://jakarta.apache.org/site/mail.html

3. Contact and Who We Are
http://jakarta.apache.org/site/contact.html
http://jakarta.apache.org/site/whoweare.html


Technically, the decision is whether we want to copy and
keep the site deployment process used at Jakarta, or whether
we want to switch to a completely mavenized site deployment.
I have no concerns about parts 2 and 3, but I can't tell
how easy or hard it is to fit part 1 into Maven. We'd also
need a place to put the .htaccess file for the site, but
I trust that can be handled by Maven.

>From a content structure point of view, that decision
translates to being HttpComponents [1] with an HttpClient 3.1
attachment [2], or being a project which has HttpComponents
and HttpClient 3.1 on the same level (and 3 look&feels).

[1] http://jakarta.apache.org/httpcomponents/index.html
[2] http://jakarta.apache.org/httpcomponents/httpclient-3.x/index.html

If it wasn't for part 1 above and my mistrust of Maven,
I'd clearly opt for the completely mavenized version.
But the Jakarta site deployment process, which transfers
generated pages to the site via SVN, somehow gives me a
better feeling than the Maven style which just copies
everything over to the server in a big bunch.


On a related matter, what paths are we going to use?
If we don't copy the Jakarta site deployment, we'll
probably collapse jakarta.a.o/httpcomponents/ to
hc.a.o/. The individual components would then still
have the full project names in the paths:
http://hc.apache.org/httpcomponents-core/index.html
http://hc.apache.org/httpcomponents-client/index.html

And what is your preferred pathname for the 3.1 site?
http://hc.apache.org/httpclient-3.x/index.html
http://hc.apache.org/commons-httpclient/index.html
...

cheers,
  Roland


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by sebb <se...@gmail.com>.
On 14/12/2007, Roland Weber <os...@dubioso.net> wrote:
> Hi Sebastian,
>
> >> The alternative to all-Maven is to use Maven only for the sites
> >> in the deliverables (HttpClient 3.1, HttpCore, HttpClient 4.0)
> >> and to use the XSLT or Anakia approach for all online-only pages.
> >> I really haven't made up my mind yet.
> >
> > Maven does seem to be good for site building; it produces some useful
> > reports which might be hard work otherwise. e.g. the Xref looks nice.
> >
> > I think the sites in the deliverables should be a subset of the
> > web-site, not something completely different.
>
> That's what I meant, sorry for not being clear about this.
>
> HttpClient 3.x ships with a full copy of it's site:
> http://jakarta.apache.org/httpcomponents/httpclient-3.x/
>
> HttpCore and HttpClient 4.0 currently do not contain the
> respective component site, but that's something we can change:
> http://jakarta.apache.org/httpcomponents/httpcomponents-core/index.html
> http://jakarta.apache.org/httpcomponents/httpcomponents-client/index.html
>
> The project/ folder in SVN holds the part of our current
> site that is not tied to a deliverable (=component):
> http://jakarta.apache.org/httpcomponents/
>
> So when I wrote "sites in the deliverables", I meant that we could
> use Maven to generate and deploy the component sites online as well
> as package them in the deliverables themselves. But everything
> above the component level could be generated with XSLT or Anakia.

OK, I see now.

> cheers,
>  Roland
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Roland Weber <os...@dubioso.net>.
Hi Sebastian,

>> The alternative to all-Maven is to use Maven only for the sites
>> in the deliverables (HttpClient 3.1, HttpCore, HttpClient 4.0)
>> and to use the XSLT or Anakia approach for all online-only pages.
>> I really haven't made up my mind yet.
> 
> Maven does seem to be good for site building; it produces some useful
> reports which might be hard work otherwise. e.g. the Xref looks nice.
> 
> I think the sites in the deliverables should be a subset of the
> web-site, not something completely different.

That's what I meant, sorry for not being clear about this.
HttpClient 3.x ships with a full copy of it's site:
http://jakarta.apache.org/httpcomponents/httpclient-3.x/

HttpCore and HttpClient 4.0 currently do not contain the
respective component site, but that's something we can change:
http://jakarta.apache.org/httpcomponents/httpcomponents-core/index.html
http://jakarta.apache.org/httpcomponents/httpcomponents-client/index.html

The project/ folder in SVN holds the part of our current
site that is not tied to a deliverable (=component):
http://jakarta.apache.org/httpcomponents/

So when I wrote "sites in the deliverables", I meant that we could
use Maven to generate and deploy the component sites online as well
as package them in the deliverables themselves. But everything
above the component level could be generated with XSLT or Anakia.

cheers,
  Roland

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by sebb <se...@gmail.com>.
On 14/12/2007, Roland Weber <os...@dubioso.net> wrote:
> Hello Sebastian,
>
> >> 1. the download pages
> >> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpcore.cgi
> >> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpclient.cgi
> >> http://jakarta.apache.org/site/downloads/downloads_commons-httpclient-3.x.cgi
> >
> > Also need the corresponding html files.
>
> The html files seem to be templates for the cgi.
> At least the "Change" button on the html version
> only triggers errors, and the drop-down list looks
> like it contains just placeholders.

Yes - the cgi passes the html through a Python script which fills in the blanks.
But both have to be there.

Actually the cgi file is the same for every project; just the name &
location changes.

> > These are both currently autogenerated using XSLT.
> >
> >> 2. Bylaws & Guidelines
> >> http://jakarta.apache.org/site/management.html
> >> http://jakarta.apache.org/site/guidelines.html
> >>       + some referenced from guidelines.html
> >> http://jakarta.apache.org/site/mail.html
> >
> > OK - some of this material could perhaps be pushed up to ASF level,
> > but given that Jakarta did not do it...
>
> Maybe it has to do with the fact that PMCs are expected
> to define their own bylaws and modes of operation. A lot
> of the stuff on these pages needs to be filtered of course,
> but some seemed useful.
>
> > Indeed - there does not seem to be an SVN copy of the site with Maven,
> > so if it gets lost/damaged it has to be regenerated as far as I can
> > tell.
> >
> > The Jakarta way makes it easy; can get everything ready in SVN first,
> > and then update the site.
>
> And you can svn diff which files have actually changed.

Yes.

> > It's also easy to detect if the site files have been editted directly;
> > as the Maven stuff is not in SVN there's no easy way to check for
> > changed, missing or additional files.
> >
> > But perhaps one can combine the two approaches?
> > Use Maven to generate the site, and rather than upload it directly,
> > store it in SVN.
>
> One can use Maven to deploy to a staging location. But iirc,
> the Jakarta XSLT stuff also has some additional processing
> to normalize the generated files. Otherwise, generated files
> may differ (depending on JDK/XSLT/OS used) even though the
> content is identical.

Yes, that was my doing. I got fed up with seeing huge SVN diffs that
did not relate to actual differences. Made it very tricky to tell if
ones updates were correct before committing them...

Dunno whether the Maven output will vary in the same way.
But at present there are fewer people likely to do the build, so fewer
possible combinations of software (or we may be able to standardise).

> The alternative to all-Maven is to use Maven only for the sites
> in the deliverables (HttpClient 3.1, HttpCore, HttpClient 4.0)
> and to use the XSLT or Anakia approach for all online-only pages.
> I really haven't made up my mind yet.

Maven does seem to be good for site building; it produces some useful
reports which might be hard work otherwise. e.g. the Xref looks nice.

I think the sites in the deliverables should be a subset of the
web-site, not something completely different.

> cheers,
>  Roland
>
>
> >> And what is your preferred pathname for the 3.1 site?
> >> http://hc.apache.org/httpclient-3.x/index.html
> >
> > +1
>
> (counted :-)
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Roland Weber <os...@dubioso.net>.
Hello Sebastian,

>> 1. the download pages
>> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpcore.cgi
>> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpclient.cgi
>> http://jakarta.apache.org/site/downloads/downloads_commons-httpclient-3.x.cgi
> 
> Also need the corresponding html files.

The html files seem to be templates for the cgi.
At least the "Change" button on the html version
only triggers errors, and the drop-down list looks
like it contains just placeholders.

> These are both currently autogenerated using XSLT.
> 
>> 2. Bylaws & Guidelines
>> http://jakarta.apache.org/site/management.html
>> http://jakarta.apache.org/site/guidelines.html
>>       + some referenced from guidelines.html
>> http://jakarta.apache.org/site/mail.html
> 
> OK - some of this material could perhaps be pushed up to ASF level,
> but given that Jakarta did not do it...

Maybe it has to do with the fact that PMCs are expected
to define their own bylaws and modes of operation. A lot
of the stuff on these pages needs to be filtered of course,
but some seemed useful.

> Indeed - there does not seem to be an SVN copy of the site with Maven,
> so if it gets lost/damaged it has to be regenerated as far as I can
> tell.
> 
> The Jakarta way makes it easy; can get everything ready in SVN first,
> and then update the site.

And you can svn diff which files have actually changed.

> It's also easy to detect if the site files have been editted directly;
> as the Maven stuff is not in SVN there's no easy way to check for
> changed, missing or additional files.
> 
> But perhaps one can combine the two approaches?
> Use Maven to generate the site, and rather than upload it directly,
> store it in SVN.

One can use Maven to deploy to a staging location. But iirc,
the Jakarta XSLT stuff also has some additional processing
to normalize the generated files. Otherwise, generated files
may differ (depending on JDK/XSLT/OS used) even though the
content is identical.

The alternative to all-Maven is to use Maven only for the sites
in the deliverables (HttpClient 3.1, HttpCore, HttpClient 4.0)
and to use the XSLT or Anakia approach for all online-only pages.
I really haven't made up my mind yet.

cheers,
  Roland


>> And what is your preferred pathname for the 3.1 site?
>> http://hc.apache.org/httpclient-3.x/index.html
> 
> +1

(counted :-)



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by sebb <se...@gmail.com>.
On 14/12/2007, Roland Weber <os...@dubioso.net> wrote:
> Hi folks,
>
> since we'll be moving to our own website soonish,
> let's discuss how we're going to structure it.
> Erik suggested to copy over parts of the Jakarta
> website such as the bylaws. I've taken a look to
> identify which of the Jakarta pages may be useful
> for us and do not have a corresponding page below
> jakarta/httpcomponents/. I found
>
> 1. the download pages
> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpcore.cgi
> http://jakarta.apache.org/site/downloads/downloads_httpcomponents-httpclient.cgi
> http://jakarta.apache.org/site/downloads/downloads_commons-httpclient-3.x.cgi

Also need the corresponding html files.

These are both currently autogenerated using XSLT.

> 2. Bylaws & Guidelines
> http://jakarta.apache.org/site/management.html
> http://jakarta.apache.org/site/guidelines.html
>       + some referenced from guidelines.html
> http://jakarta.apache.org/site/mail.html

OK - some of this material could perhaps be pushed up to ASF level,
but given that Jakarta did not do it...

> 3. Contact and Who We Are
> http://jakarta.apache.org/site/contact.html
> http://jakarta.apache.org/site/whoweare.html

OK

> Technically, the decision is whether we want to copy and
> keep the site deployment process used at Jakarta, or whether
> we want to switch to a completely mavenized site deployment.
> I have no concerns about parts 2 and 3, but I can't tell
> how easy or hard it is to fit part 1 into Maven. We'd also
> need a place to put the .htaccess file for the site, but
> I trust that can be handled by Maven.
>
> From a content structure point of view, that decision
> translates to being HttpComponents [1] with an HttpClient 3.1
> attachment [2], or being a project which has HttpComponents
> and HttpClient 3.1 on the same level (and 3 look&feels).
>
> [1] http://jakarta.apache.org/httpcomponents/index.html
> [2] http://jakarta.apache.org/httpcomponents/httpclient-3.x/index.html
>
> If it wasn't for part 1 above and my mistrust of Maven,
> I'd clearly opt for the completely mavenized version.
> But the Jakarta site deployment process, which transfers
> generated pages to the site via SVN, somehow gives me a
> better feeling than the Maven style which just copies
> everything over to the server in a big bunch.
>

Indeed - there does not seem to be an SVN copy of the site with Maven,
so if it gets lost/damaged it has to be regenerated as far as I can
tell.

The Jakarta way makes it easy; can get everything ready in SVN first,
and then update the site.

It's also easy to detect if the site files have been editted directly;
as the Maven stuff is not in SVN there's no easy way to check for
changed, missing or additional files.

But perhaps one can combine the two approaches?
Use Maven to generate the site, and rather than upload it directly,
store it in SVN.

> On a related matter, what paths are we going to use?
> If we don't copy the Jakarta site deployment, we'll
> probably collapse jakarta.a.o/httpcomponents/ to
> hc.a.o/. The individual components would then still
> have the full project names in the paths:
> http://hc.apache.org/httpcomponents-core/index.html
> http://hc.apache.org/httpcomponents-client/index.html
>
> And what is your preferred pathname for the 3.1 site?
> http://hc.apache.org/httpclient-3.x/index.html

+1

> http://hc.apache.org/commons-httpclient/index.html

OK, but prefer previous.

> ...
>
> cheers,
>  Roland
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: APT

Posted by Roland Weber <os...@dubioso.net>.
Oleg Kalnichevski wrote:
> 
> There is an option to use xdoc format for complex pages where APT may
> prove lacking or too constraining.

Yes, that will be my choice when it comes to
writing the tutorial. A long way to go :-)

cheers,
  Roland


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: APT (was: [DISCUSS] future web site structure)

Posted by Oleg Kalnichevski <ol...@apache.org>.
On Thu, 2007-12-20 at 19:06 +0100, Roland Weber wrote:
> Roland Weber wrote:
> > 
> > [1] http://maven.apache.org/doxia/references/apt-format.html
> 
> I don't know what this reference documents, but certainly
> not the format interpreted by the Maven on my machine.
> The anchor/link mechanism is seriously broken, or at
> least behaves completely different from how I interpret
> the reference.
> 
> {{anchor}} does not create a link to the "anchor" in the
> same document, it creates a link to a different document
> with name "anchor". There are no implicit anchors defined
> for the section headers. And {anchor} will not define an
> invisible anchor similar to <a name="anchor"></a>. Instead,
> it generates <a name="anchor">anchor</a>, which leads to
> an underscored text with our stylesheet. The links could
> be hack-fixed as {{{#anchor}anchor}}.
> 
> Maybe this can be rectified by upgrading some plugins, but
> it is beyond my patience for this evening to investigate
> that. For the time being, I can only recommend to not use
> in-document links with APT.
> 

Roland,

There is an option to use xdoc format for complex pages where APT may
prove lacking or too constraining.

Oleg


> cheers,
>   Roland
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
> 
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


APT (was: [DISCUSS] future web site structure)

Posted by Roland Weber <os...@dubioso.net>.
Roland Weber wrote:
> 
> [1] http://maven.apache.org/doxia/references/apt-format.html

I don't know what this reference documents, but certainly
not the format interpreted by the Maven on my machine.
The anchor/link mechanism is seriously broken, or at
least behaves completely different from how I interpret
the reference.

{{anchor}} does not create a link to the "anchor" in the
same document, it creates a link to a different document
with name "anchor". There are no implicit anchors defined
for the section headers. And {anchor} will not define an
invisible anchor similar to <a name="anchor"></a>. Instead,
it generates <a name="anchor">anchor</a>, which leads to
an underscored text with our stylesheet. The links could
be hack-fixed as {{{#anchor}anchor}}.

Maybe this can be rectified by upgrading some plugins, but
it is beyond my patience for this evening to investigate
that. For the time being, I can only recommend to not use
in-document links with APT.

cheers,
  Roland

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by sebb <se...@gmail.com>.
On 20/12/2007, Roland Weber <os...@dubioso.net> wrote:
> Hi Oleg,
>
> >> I start to get the feeling that Maven is a black hole that
> >> drags everything into it.
> >
> > Maven is VERY invasive. It either its way or the highway. However, it
> > does help to enforce uniform release structure and process, which is, in
> > my opinion, a good thing.
>
> I'm fine with Maven as a _release_ build tool. I'm less fine
> with Maven as a site generation tool. I see the point as long
> as the site is published with the release, as is the case for
> commons-httpclient with it's extensive documentation. That's
> why I suggested to use Maven for the parts of the site that
> are associated with a component and usually updated only after
> a release, and use something else for the "main" site that
> could see intermediate updates. But even that won't work if
> we want to add documentation to a component and publish that
> without waiting for the next release.
>
> I just noticed that the HttpComponents site only uses Maven
> report plugins that are tied to the source code, which is
> good. The 3.1 site also generates reports from SVN, which
> makes little sense unless the site is updated on a regular
> basis.
> Would you mind me removing the "Change Log", "Developer Activity"
> and "File Activity" reports from the old site? Some others also
> make little sense, given the current change frequency in the
> 3.1 codebase: "JavaDoc Report", "JavaDoc Warnings Report", and
> "Task List". But maybe you are using these locally when coding?
>
> > Roland, Sebastian
> >
> > Feel free to explore alternatives. I will happily step aside for a
> > while.
>
> I don't have a short-term alternative that supports a friendly
> wiki-like text markup. I'm beginning to think that it isn't
> such a bad idea to have a site published from a Confluence Wiki
> though.
> Go ahead with Maven site building. We can consider alternatives
> next year, when the dust has settled. I'll find enough to do to
> keep me occupied.

+1, ditto.

> cheers,
>  Roland
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Roland Weber <os...@dubioso.net>.
Hi Oleg,

>> I start to get the feeling that Maven is a black hole that
>> drags everything into it.
> 
> Maven is VERY invasive. It either its way or the highway. However, it
> does help to enforce uniform release structure and process, which is, in
> my opinion, a good thing. 

I'm fine with Maven as a _release_ build tool. I'm less fine
with Maven as a site generation tool. I see the point as long
as the site is published with the release, as is the case for
commons-httpclient with it's extensive documentation. That's
why I suggested to use Maven for the parts of the site that
are associated with a component and usually updated only after
a release, and use something else for the "main" site that
could see intermediate updates. But even that won't work if
we want to add documentation to a component and publish that
without waiting for the next release.

I just noticed that the HttpComponents site only uses Maven
report plugins that are tied to the source code, which is
good. The 3.1 site also generates reports from SVN, which
makes little sense unless the site is updated on a regular
basis.
Would you mind me removing the "Change Log", "Developer Activity"
and "File Activity" reports from the old site? Some others also
make little sense, given the current change frequency in the
3.1 codebase: "JavaDoc Report", "JavaDoc Warnings Report", and
"Task List". But maybe you are using these locally when coding?

> Roland, Sebastian
> 
> Feel free to explore alternatives. I will happily step aside for a
> while.

I don't have a short-term alternative that supports a friendly
wiki-like text markup. I'm beginning to think that it isn't
such a bad idea to have a site published from a Confluence Wiki
though.
Go ahead with Maven site building. We can consider alternatives
next year, when the dust has settled. I'll find enough to do to
keep me occupied.

cheers,
  Roland

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Oleg Kalnichevski <ol...@apache.org>.
On Thu, 2007-12-20 at 09:30 +0100, Roland Weber wrote:
> Oleg Kalnichevski wrote:
> > I personally prefer to use just one tool for web site authoring. So far
> > Maven was good enough
> 
> Was it? 

I think it was. At least for me.

> Actually, I do have some questions. When I generate the site
> for one of the components, I see several "reports" being run, including
> JavaDocs. Does that mean Maven picks up the JavaDocs from trunk when
> we redeploy a component site?

As far as I know Maven always use the local snapshot. The snapshot can
either off the trunk or a tag.

> I start to get the feeling that Maven is a black hole that
> drags everything into it.

Maven is VERY invasive. It either its way or the highway. However, it
does help to enforce uniform release structure and process, which is, in
my opinion, a good thing. 

>  Once you do something with Maven,
> you'll never be able to do it any other way. And the argument
> of not using two different tools for the same thing then
> eliminates all alternatives.
> 
> Anyway, go ahead. Saves me the time I meant to put into
> adapting the Jakarta site generation :-)
> 

Roland, Sebastian

Feel free to explore alternatives. I will happily step aside for a
while.

Cheers

Oleg 

> cheers,
>   Roland
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
> 
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Roland Weber <os...@dubioso.net>.
Oleg Kalnichevski wrote:
> I personally prefer to use just one tool for web site authoring. So far
> Maven was good enough

Was it? Actually, I do have some questions. When I generate the site
for one of the components, I see several "reports" being run, including
JavaDocs. Does that mean Maven picks up the JavaDocs from trunk when
we redeploy a component site? Or is there some hidden magic somewhere
that I have to learn about?
Of course that is not a problem for the main site, where we don't
have generated reports. I guess Maven has some more magic built in
to decide which parts of the target directory needs to be deleted
and which parts are from a component site.

> and I somehow prefer its wiki like APT format to XML.

That is a good point. By the way, the comment marker in
APT [1] is ~~, you may want to add the Apache boilerplate
to the APT pages.
Doxia [2] seems to be able to run outside of Maven, too.
At least they have a Java API that one could call from
an Ant task or standalone Java program. I couldn't find
anything about a standard  Ant task or command line tool
though.

[1] http://maven.apache.org/doxia/references/apt-format.html
[2] http://maven.apache.org/doxia/overview.html


Jakarta has a news site that generates an RSS feed.
Not that I use RSS, but it seems like a nice feature.

> I could put together a download section and the 'powered by' page
> tomorrow or on the weekend, if nobody objects my doing that in APT.

I start to get the feeling that Maven is a black hole that
drags everything into it. Once you do something with Maven,
you'll never be able to do it any other way. And the argument
of not using two different tools for the same thing then
eliminates all alternatives.

Anyway, go ahead. Saves me the time I meant to put into
adapting the Jakarta site generation :-)

cheers,
  Roland

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by sebb <se...@gmail.com>.
On 19/12/2007, Oleg Kalnichevski <ol...@apache.org> wrote:
>
> On Fri, 2007-12-14 at 17:11 +0100, Roland Weber wrote:
> > Hi folks,
> >
>
> ...
>
>
> > If it wasn't for part 1 above and my mistrust of Maven,
> > I'd clearly opt for the completely mavenized version.
> > But the Jakarta site deployment process, which transfers
> > generated pages to the site via SVN, somehow gives me a
> > better feeling than the Maven style which just copies
> > everything over to the server in a big bunch.
>
>
> Roland,
>
> I personally prefer to use just one tool for web site authoring. So far
> Maven was good enough and I somehow prefer its wiki like APT format to
> XML.
>
> I could put together a download section and the 'powered by' page
> tomorrow or on the weekend, if nobody objects my doing that in APT.
>

So long as it is documented how to build and deploy the site ...

I think it would be worth generating the site to a directory structure
which is stored in SVN. Deployment is then trivial, and the site can
readily be bundled into an archive if required.

It works well for the Jakarta and JMeter sites.

> Oleg
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> For additional commands, e-mail: dev-help@hc.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [DISCUSS] future web site structure

Posted by Oleg Kalnichevski <ol...@apache.org>.
On Fri, 2007-12-14 at 17:11 +0100, Roland Weber wrote:
> Hi folks,
> 

...


> If it wasn't for part 1 above and my mistrust of Maven,
> I'd clearly opt for the completely mavenized version.
> But the Jakarta site deployment process, which transfers
> generated pages to the site via SVN, somehow gives me a
> better feeling than the Maven style which just copies
> everything over to the server in a big bunch.


Roland,

I personally prefer to use just one tool for web site authoring. So far
Maven was good enough and I somehow prefer its wiki like APT format to
XML.

I could put together a download section and the 'powered by' page
tomorrow or on the weekend, if nobody objects my doing that in APT.

Oleg 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org