[site] Generating the project site

[Trustin Lee <tr...@gmail.com>]

Hi all,

For now we put site source into trunk/site and trunk/<projectId>/site
directory and use Maven 2 to generate the actual HTML web site and deploy
it.  This is generally good for us because M2 automates most of the
process.  However, there's an important problem that our new site apparently
has a broken part for now because of the bugs or lack of features in M2
plugins.  Considering the current situation, I think we need to use both M2
and script-based site generation tool to generate more perfect site.  For
example, we could put a script like this:

# trunks/sh-scripts/generate-site.sh:
#!/bin/sh
mvn site # Let M2 generate most part
javadoc ... # generate JavaDoc for some project
xref ... # generate XRef for some project
...

Of course, a shell script is just an example; we can use an Ant script to do
this.

WDYT?

Trustin
--
what we call human nature is actually human habit
--
http://gleamynode.net/
PGP Key ID: 0x854B996C

Re: [site] Generating the project site

[Brett Porter <br...@gmail.com>]

Hi guys,

Sorry the Maven site plugin issues are taking longer than I had
anticipated. Need more free time! Thanks for your patience so far.

Can you file issues against MSITE for things you'd like to see included?

You might be interested in some recent discussions about site
structuring in the Maven tree itself:
http://www.nabble.com/Parent-vs-dependency-aggregation%2C-including-sites-and-reports-t1074248.html
http://www.nabble.com/a-little-more-on-site-structure-t1080884.html
http://www.nabble.com/Re%3A-discuss-change-to-parent-hierachy-p2815800.html

Cheers,
Brett

On 2/8/06, Ersin Er <er...@gmail.com> wrote:
> Hi,
>
> On 2/8/06, Trustin Lee <tr...@gmail.com> wrote:
> > Hi all,
> >
> > For now we put site source into trunk/site and trunk/<projectId>/site
> > directory and use Maven 2 to generate the actual HTML web site and deploy
> > it.  This is generally good for us because M2 automates most of the process.
> >  However, there's an important problem that our new site apparently has a
> > broken part for now because of the bugs or lack of features in M2 plugins.
> > Considering the current situation, I think we need to use both M2 and
> > script-based site generation tool to generate more perfect site.
>
> I agree on a m2+script approach. Maven itself cannot handle some stuff
> like, generating a fully connected site. We expecially need it for
> docos that will be put into project installers for people to have it
> when they install the app.
>
> > For
> > example, we could put a script like this:
> >
> > # trunks/sh-scripts/generate-site.sh:
> > #!/bin/sh
> > mvn site # Let M2 generate most part
> > javadoc ... # generate JavaDoc for some project
> > xref ... # generate XRef for some project
> > ...
>
> I'm currently writing some sh scripts for doing some work. But they're
> not for making the site superior, they're just some hacks. (Command
> like XML parsing is cool ;-) ) I'll work on it more today and I'll
> have more to say about this topic.
>
> > Of course, a shell script is just an example; we can use an Ant script to do
> > this.
>
> Ant seems to be a good candidate for things that will be done without m2.
>
> > WDYT?
> >
> > Trustin
> > --
> > what we call human nature is actually human habit
> > --
> > http://gleamynode.net/
> > PGP Key ID: 0x854B996C
>
>
> --
> Ersin
>

Re: [site] Generating the project site

[Ersin Er <er...@gmail.com>]

I've generated fully conected ApacheDS and MINA apidocs here:

http://people.apache.org/~ersiner/apidocs/

I've wrote a simple shell script for inclusions and exclusions. With
the help of javadoc tool, the process is almost automatic.

I'll do a few more customization for doctitle etc and it'll be ok I
think. We can write an ant task to upload and extract it to site
server. Before that we can go manually for some time.

Now the remaning issue is a fully connected xref. I do not have much
idea about it yet.

On 2/8/06, Ersin Er <er...@gmail.com> wrote:
> Hi,
>
> On 2/8/06, Trustin Lee <tr...@gmail.com> wrote:
> > Hi all,
> >
> > For now we put site source into trunk/site and trunk/<projectId>/site
> > directory and use Maven 2 to generate the actual HTML web site and deploy
> > it.  This is generally good for us because M2 automates most of the process.
> >  However, there's an important problem that our new site apparently has a
> > broken part for now because of the bugs or lack of features in M2 plugins.
> > Considering the current situation, I think we need to use both M2 and
> > script-based site generation tool to generate more perfect site.
>
> I agree on a m2+script approach. Maven itself cannot handle some stuff
> like, generating a fully connected site. We expecially need it for
> docos that will be put into project installers for people to have it
> when they install the app.
>
> > For
> > example, we could put a script like this:
> >
> > # trunks/sh-scripts/generate-site.sh:
> > #!/bin/sh
> > mvn site # Let M2 generate most part
> > javadoc ... # generate JavaDoc for some project
> > xref ... # generate XRef for some project
> > ...
>
> I'm currently writing some sh scripts for doing some work. But they're
> not for making the site superior, they're just some hacks. (Command
> like XML parsing is cool ;-) ) I'll work on it more today and I'll
> have more to say about this topic.
>
> > Of course, a shell script is just an example; we can use an Ant script to do
> > this.
>
> Ant seems to be a good candidate for things that will be done without m2.
>
> > WDYT?
> >
> > Trustin
> > --
> > what we call human nature is actually human habit
> > --
> > http://gleamynode.net/
> > PGP Key ID: 0x854B996C
>
>
> --
> Ersin
>


--
Ersin

Re: [site] Generating the project site

[Ersin Er <er...@gmail.com>]

Hi,

On 2/8/06, Trustin Lee <tr...@gmail.com> wrote:
> Hi all,
>
> For now we put site source into trunk/site and trunk/<projectId>/site
> directory and use Maven 2 to generate the actual HTML web site and deploy
> it.  This is generally good for us because M2 automates most of the process.
>  However, there's an important problem that our new site apparently has a
> broken part for now because of the bugs or lack of features in M2 plugins.
> Considering the current situation, I think we need to use both M2 and
> script-based site generation tool to generate more perfect site.

I agree on a m2+script approach. Maven itself cannot handle some stuff
like, generating a fully connected site. We expecially need it for
docos that will be put into project installers for people to have it
when they install the app.

> For
> example, we could put a script like this:
>
> # trunks/sh-scripts/generate-site.sh:
> #!/bin/sh
> mvn site # Let M2 generate most part
> javadoc ... # generate JavaDoc for some project
> xref ... # generate XRef for some project
> ...

I'm currently writing some sh scripts for doing some work. But they're
not for making the site superior, they're just some hacks. (Command
like XML parsing is cool ;-) ) I'll work on it more today and I'll
have more to say about this topic.

> Of course, a shell script is just an example; we can use an Ant script to do
> this.

Ant seems to be a good candidate for things that will be done without m2.

> WDYT?
>
> Trustin
> --
> what we call human nature is actually human habit
> --
> http://gleamynode.net/
> PGP Key ID: 0x854B996C


--
Ersin