You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by Ted Husted <te...@gmail.com> on 2006/05/07 13:29:57 UTC

[Action2] STATUS - Documentation

I've been trudging through the SAF2 wiki, updating the links,
nomenclature, and formatting for an Action 2 distribution.  Aside from
the mechanical work, I've also been filling in the TODOs and smoothing
over other rough spots.

I should be able to get through the rest of the Reference section this
week. The next step would be to update the Javadocs and corresponding
"snippet" paths. (The wiki utilizes a nifty macro that lets you
incorporate portions of the Javadocs into the wiki text.)

Once we get through the Javadoc snippets, I expect that we could
generate a preliminary HTML version for the Apache Struts website. We
might then follow the convention of maintaining the "nightly build"
version on the wiki, and generating a HTML version for the website as
part of the release process.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/8/06, Don Brown <do...@gmail.com> wrote under the [ANN]
... Action 2 .. thread:

> Yeah, I hadn't done that previously as I'm not sure my poor server
> could handle the load, and the fact ASF infrastructure is balking at
> running a live Confluence doesn't add confidence :)

If a Confluence space on an ASF server is not going to happen soon,
then perhaps we should move the space to a Contegrix server. The
"OpenSource" instance is already available to ASF projects, and being
used by iBATIS and Geronimo. We could move everthing over today,
except that I'm unable to export a space as large as ours. Smaller
chunks can be exported, but not the whole space at once. (Apparently,
size matters.)

Do we know if the automatic Confluence backups are running? If so, can
you upload one to your ASF home directory? I'd like to try installing
it here, and seeing if I can run a backup from one of my workstations.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Eric Molitor <em...@molitor.org>.
On 5/8/06, Ted Husted <te...@gmail.com> wrote:
> I haven't been able to get an export of the SAF2 wiki in any format.
> I've let the process run for over an hour, but it never seems to
> return.
>

Smells like the same issue encountered when trying to export the WW
2.2.2 docs for release. Anybody know what Contegix did to get the docs
to export?

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
I haven't been able to get an export of the SAF2 wiki in any format.
I've let the process run for over an hour, but it never seems to
return.

Is a space export what we were doing for the WW2 releases? Or something else?

For now, I linked the SAF2 space to the "Action Framework 2" link on
the Apache Struts home page. I'm thinking the end-game should be to
get an export of the space posted on the web server and link to that
instead.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by tm jee <tm...@yahoo.co.uk>.
Lovely. Thx Pat. 


----- Original Message ----
From: Patrick Lightbody <fo...@opensymphony.com>
To: dev@struts.apache.org
Sent: Monday, 15 May, 2006 1:56:51 AM
Subject: Re: [Action2] STATUS - Documentation

The snippet macro is updated. You can use URLs in the following format:

org.struts.apache.action2.xxxx (links directly to a class in the _core_ module only)
action2/... (links from the root of the action2 trunk)

We'll need to get all references to the webwork snippets switched over as the next step for the docs.
---------------------------------------------------------------------
Posted via Jive Forums
http://forums.opensymphony.com/thread.jspa?threadID=29760&messageID=59616#59616


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





Re: [Action2] STATUS - Documentation

Posted by Patrick Lightbody <fo...@opensymphony.com>.
The snippet macro is updated. You can use URLs in the following format:

org.struts.apache.action2.xxxx (links directly to a class in the _core_ module only)
action2/... (links from the root of the action2 trunk)

We'll need to get all references to the webwork snippets switched over as the next step for the docs.
---------------------------------------------------------------------
Posted via Jive Forums
http://forums.opensymphony.com/thread.jspa?threadID=29760&messageID=59616#59616


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


Re: [Action2] STATUS - Documentation

Posted by Patrick Lightbody <fo...@opensymphony.com>.
I'll get the snippet macro fixed today or tomorrow. Let's definitely avoid absolute URLs, since it just makes it harder to change in the future.
---------------------------------------------------------------------
Posted via Jive Forums
http://forums.opensymphony.com/thread.jspa?threadID=29760&messageID=59194#59194


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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
Thanks, but almost everything was already there. I'm just making a
refactoring pass to ensure consistency and completeness.

The snippet macro does work with absolute URIs, but once the codebase
comes over from the incubator, setting up the short-cuts Toby
mentioned would certainly help.

-Ted.

On 5/7/06, Don Brown <mr...@twdata.org> wrote:
> Wow, Ted this is looking great!  I really like the new organization, as
> it is very easy to follow.  I especially appreciate the work you've put
> into the Tutorial section, as that has always been a weak area in the WW
> docs.
>
> Patrick, we need to get that snippet macro working with the new
> repository.  I think we should use struts/action2/trunk as that will be
> the new home once Infrastructure moves the project from incubation.
>
> Don
>
> Ted Husted wrote:
> > I've been trudging through the SAF2 wiki, updating the links,
> > nomenclature, and formatting for an Action 2 distribution.  Aside from
> > the mechanical work, I've also been filling in the TODOs and smoothing
> > over other rough spots.
> >
> > I should be able to get through the rest of the Reference section this
> > week. The next step would be to update the Javadocs and corresponding
> > "snippet" paths. (The wiki utilizes a nifty macro that lets you
> > incorporate portions of the Javadocs into the wiki text.)
> >
> > Once we get through the Javadoc snippets, I expect that we could
> > generate a preliminary HTML version for the Apache Struts website. We
> > might then follow the convention of maintaining the "nightly build"
> > version on the wiki, and generating a HTML version for the website as
> > part of the release process.
> >
> > -Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Don Brown <mr...@twdata.org>.
Wow, Ted this is looking great!  I really like the new organization, as 
it is very easy to follow.  I especially appreciate the work you've put 
into the Tutorial section, as that has always been a weak area in the WW 
docs.

Patrick, we need to get that snippet macro working with the new 
repository.  I think we should use struts/action2/trunk as that will be 
the new home once Infrastructure moves the project from incubation.

Don

Ted Husted wrote:
> I've been trudging through the SAF2 wiki, updating the links,
> nomenclature, and formatting for an Action 2 distribution.  Aside from
> the mechanical work, I've also been filling in the TODOs and smoothing
> over other rough spots.
>
> I should be able to get through the rest of the Reference section this
> week. The next step would be to update the Javadocs and corresponding
> "snippet" paths. (The wiki utilizes a nifty macro that lets you
> incorporate portions of the Javadocs into the wiki text.)
>
> Once we get through the Javadoc snippets, I expect that we could
> generate a preliminary HTML version for the Apache Struts website. We
> might then follow the convention of maintaining the "nightly build"
> version on the wiki, and generating a HTML version for the website as
> part of the release process.
>
> -Ted.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>


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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/14/06, Ted Husted <te...@gmail.com> wrote:
> * http://opensource.atlassian.com/confluence/oss/

I thought this would default to the dashboard, but it doesn't. Insted, try

* http://opensource.atlassian.com/confluence/oss/dashboard.action

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/14/06, Ted Husted <te...@gmail.com> wrote:
> On 5/14/06, Patrick Lightbody <fo...@opensymphony.com> wrote:
> > We won't be able to use Atlassian's public server - our stuff is just too heavy duty.
> > Contegix (not Contegrix :P) might be interested to help, but I imagine they would
> >  probably
> > feel more interested if they were in a position that was more than just an
> > emergency/temporary storage location (eg: official hosting provider for Struts - which I
> > know is a much bigger issue). I'll ask Matthew Porter next week what his thoughts are.
>
> The idea of someone being the official hosting provider of a single
> ASF project is probably a non-starter.

While hosting a particular project wouldn't fly, hosting specific
services for everyone is something else again.

The Jakarta Commons is in the process of migrating to JIRA, and this
might be a good time to suggest that an expert like Contegix host
dedicated JIRA and Confluence servers for us. The machines would have
to be ASF property, but it's possible that we could have our machines
located in someone else's service center.

Of course, the best one to talk to about our current JIRA usage is
Jeff Turner  <je...@apache.org> (who might have already been down this
road).

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/14/06, Patrick Lightbody <fo...@opensymphony.com> wrote:
> We won't be able to use Atlassian's public server - our stuff is just too heavy duty.

Is there a particular aspect of "heavy duty" that causes more
problems: Too many pages or too many hits?

If the size of a space matters, it might make sense to use multiple
spaces. I'm finding that larger spaces are harder to export. I haven't
been able to export our current space to HTML, but I have had some
luck with smaller subsets.

If we can get an export working, then we can start posting HTML to the
site and funnel visitors to the static pages. The link to the wiki, we
can keep with the "How to Help" and "Nightly Build" material. Out of
sight, out of mind.

But, we do need to fish or cut bait. Right now, it doesn't look like
the current configuration is going to work for us, simply because we
can't get an export of the space.

Regardless, I think I should ask Jeff Turner for a license that we can
use for now, before the evaluation expires.

> Contegix (not Contegrix :P) might be interested to help, but I imagine they would probably
> feel more interested if they were in a position that was more than just an
> emergency/temporary storage location (eg: official hosting provider for Struts - which I
> know is a much bigger issue). I'll ask Matthew Porter next week what his thoughts are.

Well, there's yet-another ASF Confluence thread open on infrastructure
right now, where someone is offering to donate a dedicated machine. No
one has screamed "stop" yet. There's a test instance running now on an
ASF host name now, where they are trying to run Confluence and server
statically auto exported HTML. But, there's no way to tell if this
will work out or not, and how temporary any other arrangements might
be.

The idea of someone being the official hosting provider of a single
ASF project is probably a non-starter.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Patrick Lightbody <fo...@opensymphony.com>.
We won't be able to use Atlassian's public server - our stuff is just too heavy duty. Contegix (not Contegrix :P) might be interested to help, but I imagine they would probably feel more interested if they were in a position that was more than just an emergency/temporary storage location (eg: official hosting provider for Struts - which I know is a much bigger issue). I'll ask Matthew Porter next week what his thoughts are.
---------------------------------------------------------------------
Posted via Jive Forums
http://forums.opensymphony.com/thread.jspa?threadID=29760&messageID=59617#59617


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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
I've trudged through the pages that were linked to the "home" page.
I'm now wrapping up the remaining xx pages that were not linked in
anywhere. Most of these cover the various Interceptor and Result
Types. A lot of the pages utilize the snippet macro, and so the next
step would be to review the Javadoc, and update the snippet
references. Next week, I need to update parts of the MailReader
training course for an upcoming engagement. But, I will time to wrap
up the other documentation in June.

Meanwhile, our evaluation license on Don's server is a week away from
expiring. I think we will have a ASF box to run Confluence eventually,
but it's not going to happen this week. The best thing might be to
transfer the space to a server that is being shared by other ASF
projects right now. The box was donated by Atlassian and is maintained
by Contegrix.

* http://opensource.atlassian.com/confluence/oss/

The glitch is that our space is too large to be exported in one fell
swoop. It may be a RAM issue. I'd like to try restoring one of the
nightly backups from the twdata site to a local machine, to see if we
have any better luck here.

Otherwise, we'll have to see if Atlassian/Contegrix will give us our
own space on the OSS box, or just get a complimentary license from
Atlassian that we can use on Don's box now, and then on an ASF box
later.

Meanwhile, it's worth noting that the wiki content is not "protected"
until we post it to a ASF box. In this context, protected means that
the material has been duly donated to the ASF, and tht the ASF accepts
ownership of the material. In the unlikely event of an intellectual
property lawsuit, the ASF would defend "protected" material, but *not*
material posted elsewhere. The other benefit of "protected" content is
that there is no doubt about who owns what: the ASF, a non-profit US
corporation, owns all the protected material.

Pretty soon, we should be able to start exporting and posting the wiki
material to the website, at which point that material would become
protected. But, until then, we're still on our own.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
Continues on [http://issues.apache.org/struts/browse/WW-1340]

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/18/06, Ted Husted <te...@gmail.com> wrote:
> Outstanding are about fifty "orphan" pages that were not linked into
> the home page. I'll review those next and connect them with one of the
> five sections. Once the existing material is hooked up, I thought I'd
> polish off the "step by step" tutorial, so we have a "soup to nuts"
> introduction to the framework.

OK, all the pages are "linked in" now. The "Home" page is the root,
the five sections are under that, and everything else is under one of
the five. Each page should be referenced by at least one other page,
making the wiki browsable. At some point, we might want to make each
of the five sections its own space, especially if it helps with
exporting.

Next, I'll circle back to the tutorial and set that up so it's a
step-by-step introduction to the framework, based on a single example
application.

-Ted,

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
On 5/18/06, Ted Husted <te...@gmail.com> wrote:
> So, I sent the usual openNsource application to sales@atlassian.org.

Our request for an open-source license is approved, and I inserted the
new license into our Confluence instance.

For furture reference, the account details can be found in the Apache
Struts PMC repository area.

-Ted.

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


Re: [Action2] STATUS - Documentation

Posted by Ted Husted <te...@gmail.com>.
I pinged Jeff Turner about a open source license we could use while we
sort things out, but haven't heard back. So, I sent the usual open
source application to sales@atlassian.org. Hopefully, something will
turn up before the license expires on Sunday morning. Otherwise, the
SAF2 wiki might be on a brief hiatus ...

Meanwhile, in reviewing the documentation, it seemed like most of the
material fell into five sections

* Overview
* Tutorials
* Third Party Exensions
* View Developers Guide
* Core Developers Guide

There are now "parent" pages for each section, which helps with the
"breadcrumb" navigation.

* http://confluence.twdata.org/display/WW/Home

Outstanding are about fifty "orphan" pages that were not linked into
the home page. I'll review those next and connect them with one of the
five sections. Once the existing material is hooked up, I thought I'd
polish off the "step by step" tutorial, so we have a "soup to nuts"
introduction to the framework.

At some point, we might want to consider making each of the five
sections its own space. Sometimes, Confluence has trouble exporting
smaller spaces. There would be more spaces to export, but at least we
might be able to get them to export :)

-Ted.

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