You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Rodney Waldhoff <rw...@apache.org> on 2004/07/14 16:14:20 UTC
site update process?
Is there documentation somewhere for the currently recommended process of
updating the commons site?
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
hi rodney
documentation? not that i know of (but that doesn't mean non exists).
the common part of the site is mavenized. cd common-build and type
maven site:generate to regenerate the site locally and maven
site:deploy to generate and upload.
- robert
On 14 Jul 2004, at 15:14, Rodney Waldhoff wrote:
> Is there documentation somewhere for the currently recommended process
> of updating the commons site?
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Rodney Waldhoff wrote:
> You misunderstand me.
>
> There already exists commons-site-generate and commons-site-deploy in
> commons-build/maven.xml. Do we use those? What are they for?
>
yes, I believe those were an effort to build a full commons
site+subproject sites goal by Jason. I don't believe it currently
functions, it may be wise to move it into another file to protect others
from attempting to run it.
>>
>>> Will this publish the sandbox as well, or do I do that independently?
>>
>>
>>
>> No, there is a separate sandbox-build projects for the sandbox at
>> this time.
>>
>> Just for clarification, this only rebuilds the top level site, its
>> upto each project to keep their site uptodate by running 'maven site'
>> in thier project directory.
>
>
> So if I want to update commons-foo's site, I repeat the process above,
> but from jakarta-commons/commons-foo instead, correct? Doesn't the
> maven-reactor stuff carry this through from the root on down?
>
Well, it could be possible to use the reactor in the way that
multiproject plugin or Jasons custom code, but with so many subprojects
and so much report generation I suspect it would be a very lengthy
process to complete such a full site update across the entire commons.
Plus, currently there are specializations that occur in each project,
for instance Collections producing javadoc for multiple versions which
would be wasteful to reproduce across an entire build. I believe keeping
the site update process separate for each project allows the projects to
update when they see fit, sharing the templates and navigation within
the commons-build directory allows them to have consistent L&F while
still providing this capability. They get to be unique sites, yet with a
facade unity through the commons-build L&F.
-Mark
Re: site update process?
Posted by Rodney Waldhoff <rw...@apache.org>.
On Wed, 14 Jul 2004, Mark R. Diggory wrote:
> Rodney Waldhoff wrote:
>
>> OK, so "maven site" will actually upload the site to the server?
>>
>> Specifically (all from jakarta-commons/commons-build):
>>
>> 1. run "maven site:generate" and confirm the local copy looks OK
>> 2. run "maven site" which will both generate and deploy the site
>>
>> Is that right?
>
> Pretty much. It would probibly be wise to instert a "backup step" before
> deploying just for easy recovery if anything goes wrong. while this could be
> automated, it may be wiser for the person to physically backup the
> /www/jakarta.apache.org/commons directory by hand into a temporary tar file,
> so they know they are properly backed up before going forward. Its important
> to note that all the project sites are subdirectories of
> /www/jakarta.apache.org/commons, I sometimes wish this were not the case and
> that the toplevel could be updated without any risk to the contents of those
> subdirectories, which would be the case if they existed within separate
> dorectories from the top level site.
>
>> Do we want "commons-site-generate" and "commons-site-deploy" instead?
>>
> I'd rather stick to the defaults as much as possible instead of customizing
> the goal name being called, there is still room to customize in maven.xml via
> overloading, pre-goal and post-goal tags.
You misunderstand me.
There already exists commons-site-generate and commons-site-deploy in
commons-build/maven.xml. Do we use those? What are they for?
>
>> Will this publish the sandbox as well, or do I do that independently?
>
>
> No, there is a separate sandbox-build projects for the sandbox at this time.
>
> Just for clarification, this only rebuilds the top level site, its upto each
> project to keep their site uptodate by running 'maven site' in thier project
> directory.
So if I want to update commons-foo's site, I repeat the process above,
but from jakarta-commons/commons-foo instead, correct? Doesn't the
maven-reactor stuff carry this through from the root on down?
> -Mark
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Hmm, we don't have versioning of the top level commons site at this
time, its strictly navigation and html generation. Each project does
have versioning, and this is even a greater reason why we don't build
all the commons projects documentation at once because their most
current versions are possibly under different cvs tags.
-Mark
Simon Kitching wrote:
>Hi,
>
>Just to note the obvious, the deployed site should generally be
>generated from the cvs checkout for the last official release, not CVS
>HEAD, because the jakarta sites should really reflect the state of the
>currently released version.
>
>This probably didn't need to be said...
>
>Cheers,
>
>Simon
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
>For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
>
--
Mark R. Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by Simon Kitching <si...@ecnetwork.co.nz>.
Hi,
Just to note the obvious, the deployed site should generally be
generated from the cvs checkout for the last official release, not CVS
HEAD, because the jakarta sites should really reflect the state of the
currently released version.
This probably didn't need to be said...
Cheers,
Simon
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Yes your right you need to call site:deploy.
Henri Yandell wrote:
>I didn't think that maven site deploys by default. Never had it do that
>for me when I run maven site. Usually it just puts things in the
>deploy/docs directory and I upload that manually.
>
>Hen
>
>On Wed, 14 Jul 2004, Mark R. Diggory wrote:
>
>
>
>>Rodney Waldhoff wrote:
>>
>>
>>
>>>Do we want "commons-site-generate" and "commons-site-deploy" instead?
>>>
>>>
>>>
>>I'd rather stick to the defaults as much as possible instead of
>>customizing the goal name being called, there is still room to customize
>>in maven.xml via overloading, pre-goal and post-goal tags.
>>
>>
>
>
>
Re: site update process?
Posted by Henri Yandell <ba...@generationjava.com>.
I didn't think that maven site deploys by default. Never had it do that
for me when I run maven site. Usually it just puts things in the
deploy/docs directory and I upload that manually.
Hen
On Wed, 14 Jul 2004, Mark R. Diggory wrote:
> Rodney Waldhoff wrote:
>
> > Do we want "commons-site-generate" and "commons-site-deploy" instead?
> >
> I'd rather stick to the defaults as much as possible instead of
> customizing the goal name being called, there is still room to customize
> in maven.xml via overloading, pre-goal and post-goal tags.
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Rodney Waldhoff wrote:
> OK, so "maven site" will actually upload the site to the server?
>
> Specifically (all from jakarta-commons/commons-build):
>
> 1. run "maven site:generate" and confirm the local copy looks OK
> 2. run "maven site" which will both generate and deploy the site
>
> Is that right?
Pretty much. It would probibly be wise to instert a "backup step" before
deploying just for easy recovery if anything goes wrong. while this
could be automated, it may be wiser for the person to physically backup
the /www/jakarta.apache.org/commons directory by hand into a temporary
tar file, so they know they are properly backed up before going forward.
Its important to note that all the project sites are subdirectories of
/www/jakarta.apache.org/commons, I sometimes wish this were not the case
and that the toplevel could be updated without any risk to the contents
of those subdirectories, which would be the case if they existed within
separate dorectories from the top level site.
>
> Do we want "commons-site-generate" and "commons-site-deploy" instead?
>
I'd rather stick to the defaults as much as possible instead of
customizing the goal name being called, there is still room to customize
in maven.xml via overloading, pre-goal and post-goal tags.
> Will this publish the sandbox as well, or do I do that independently?
No, there is a separate sandbox-build projects for the sandbox at this time.
Just for clarification, this only rebuilds the top level site, its upto
each project to keep their site uptodate by running 'maven site' in
thier project directory.
-Mark
> On Wed, 14 Jul 2004, Mark R. Diggory wrote:
>
>> The strategy is to use the "maven site" goal in the
>> /jakarta-commons/commons-build project to build an deploy a new copy
>> of the site. Usually it is wise to run 'site:generate' first and
>> verify the local copy was built properly.
>>
>> -Mark
>>
>> Rodney Waldhoff wrote:
>>
>>> Is there documentation somewhere for the currently recommended
>>> process of updating the commons site?
>>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
Re: site update process?
Posted by Rodney Waldhoff <rw...@apache.org>.
OK, so "maven site" will actually upload the site to the server?
Specifically (all from jakarta-commons/commons-build):
1. run "maven site:generate" and confirm the local copy looks OK
2. run "maven site" which will both generate and deploy the site
Is that right?
Do we want "commons-site-generate" and "commons-site-deploy" instead?
Will this publish the sandbox as well, or do I do that independently?
- Rod
On Wed, 14 Jul 2004, Mark R. Diggory wrote:
> The strategy is to use the "maven site" goal in the
> /jakarta-commons/commons-build project to build an deploy a new copy of the
> site. Usually it is wise to run 'site:generate' first and verify the local
> copy was built properly.
>
> -Mark
>
> Rodney Waldhoff wrote:
>
>> Is there documentation somewhere for the currently recommended process of
>> updating the commons site?
>>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: site update process?
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
The strategy is to use the "maven site" goal in the
/jakarta-commons/commons-build project to build an deploy a new copy of
the site. Usually it is wise to run 'site:generate' first and verify the
local copy was built properly.
-Mark
Rodney Waldhoff wrote:
> Is there documentation somewhere for the currently recommended process
> of updating the commons site?
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>