Skip to main content

[WEBSITES] Attention -- Files moved

6 replies [Last post]
rbair
Offline
Joined: 2003-07-08
Points: 0

Hey folks (in particular, Jeanette, Patrick, Fred):

As per Jan's call for better organization of the webpages (and PR in general), I've been working on cleaning up the websites. You'll notice that a lot of stuff was removed from CVS.

For example, there were new files in SwingX under "collapsible" that are no longer there. The files have been moved to the main SwingLabs.org website. It is available in CVS in the swinglabs.dev.java.net project, in the "website" directory.

The website is broken up fairly cleanly (if I *do* say so myself). Under docs/components you'll find a directory for each visual component we've documented so far, as well as the main frameworks (Action, Authentication, DataSet, Filters).

Feel free to edit, update, and in all other ways complete the documentation for these components.

My organization here, and the criteria I'm using to determine what goes into the various sub projects' websites as opposed to the main website, is whether the information is for internal consumption or whether it is meant for users. Any user-oriented documentation *should* be on SwingLabs.org. Any other docs (for example, the tree table spec) should be on the subproject website.

Questions? Comments? Snide Remarks?

Richard

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Kleopatra

Hi Rich,

great to see some clean-up in action :-)

Only, we have to be a bit careful when actually moving files around and
where to move them: an issue that crept up yesterday is that some links
from the wiki are broken (f.i. to the source code of collapsible
examples). Nothing dramatic, I thought, let the wiki links point to the
new location. There's a catch, though: only cvs content under the www
hierarchy are visible, swinglabs.web is not ...

The deeper problem is what to do with files that are needed both on
SwingLabs.org (which somehow takes it from swinglabs.web) and on
swinglabs.dev.java.net. These might be all kinds of documents - I expect
the distinction between "user-related" and "internal" to not always be
so clean-cut - in particular that might hold for anything used in the wiki.

Options to solve:
- put the total web under the www, that is swinglabs.www.web.*
- have duplicates around, one under the swinglabs.web, another under

.www
- force a clear decision about where any given file should show up
- ?? (further ideas?)

With the last not always possible (will automatically lead to the second
:-), with duplicates always being a bad idea my preference would be the
first.

Comments?

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

rbair
Offline
Joined: 2003-07-08
Points: 0

> Only, we have to be a bit careful when actually
> moving files around and
> where to move them: an issue that crept up yesterday
> is that some links
> from the wiki are broken (f.i. to the source code of
> collapsible
> examples). Nothing dramatic, I thought, let the wiki
> links point to the
> new location. There's a catch, though: only cvs
> content under the www
> hierarchy are visible, swinglabs.web is not ...

Hmmm... maybe it didn't get committed, but the actual swinglabs.org website is in CVS for swinglabs.dev.java.net under "website" (as opposed to www). I'll have to check and see if I've committed the files that were moved there (I believe I did. I think the only thing I had left to do was build and deploy the updated website).

> The deeper problem is what to do with files that are
> needed both on
> SwingLabs.org (which somehow takes it from
> swinglabs.web) and on
> swinglabs.dev.java.net. These might be all kinds of
> documents - I expect
> the distinction between "user-related" and "internal"
> to not always be
> so clean-cut - in particular that might hold for
> anything used in the wiki.
>
> Options to solve:
> - put the total web under the www, that is
> swinglabs.www.web.*
> - have duplicates around, one under the
> swinglabs.web, another under
>
.www
> - force a clear decision about where any given file
> should show up
> - ?? (further ideas?)
>
> With the last not always possible (will automatically
> lead to the second
> :-), with duplicates always being a bad idea my
> preference would be the
> first.

Actually, I'm perfectly happy with:
- force an unclear decision about where any given file should show up :)

I'm only half kidding -- in a large way I don't think it matters that much. If I had to choose one way or the other, I'd rather that the document was on the swinglabs.org website than the various project websites. If it clearly belonged on the project website (like the UE documentation for JXTreeTable) then we'd just put it there. If there is any question, put it on SwingLabs.org.

This has the following benefits:

* Not too much decision overhead
* Documents are in a consistent visual format
* Docs on SwingLabs.org will make it easier for people
to navigate to the other parts of swinglabs.org such
as downloads

Richard

kleopatra
Offline
Joined: 2003-06-11
Points: 0

Hi Rich,

> Hmmm... maybe it didn't get committed, but the actual
> swinglabs.org website is in CVS for
> swinglabs.dev.java.net under "website" (as opposed to
> www). I'll have to check and see if I've committed
> the files that were moved there (I believe I did. I
> think the only thing I had left to do was build and
> deploy the updated website).

They are there, all committed - but that exactly is the problem: _because_ they are under website as opposed to under www they can't be linked to from the wiki or any other location. BTW, how are they moved to swinglabs.org? Or are they actually moved? Probably, because they are not linkable (because they are not under the www subtree). Is/will be that automated in any way?

Scratching my head ...

BTW, I am always in favor of low overhead strategies, 100% ack for your bulleted points. Only there are files moved around to where they are no longer linkable leading to broken links - that needs to be solved somehow.

Have a nice weekend, and get some rest - you need to be fresh when the child will have arrived :-)
Jeanette

rbair
Offline
Joined: 2003-07-08
Points: 0

Hey Jeanette,

> They are there, all committed - but that exactly is
> the problem: _because_ they are under website as
> opposed to under www they can't be linked to from the
> wiki or any other location. BTW, how are they moved
> to swinglabs.org? Or are they actually moved?
> Probably, because they are not linkable (because they
> are not under the www subtree). Is/will be that
> automated in any way?

The website directory can actually be opened in netbeans as a web project. Alternatively, you can run the ant build file and build the .war file.

Deployment is simply moving the war file to the server (and modifying one servlet parameter... that's so annoying but whatever). The problem is that of course deploying the war to the server is a priviledged operation (meaning, only Jeff or I can do it).

> Scratching my head ...

Me too. If we move the project files under www, that will indeed solve the linking problem in that at least the wiki links will point to _somewhere_. But rather than pointing there, I'd rather that they pointed to swinglabs.org/docs/blah/whatever.jsp

The real problem in this is the process -- how often is the website updated? What I could do (perhaps with a little coaching from Fred who seems to know this stuff pretty well) is get an internal trusted Sun machine to automatically rebuild the .war file and deploy it whenever a commit is made to the website directory (or sub directories, of course). You won't see changes on the website instantly after commit, but probably within five minutes or so.

> BTW, I am always in favor of low overhead strategies,
> 100% ack for your bulleted points. Only there are
> files moved around to where they are no longer
> linkable leading to broken links - that needs to be
> solved somehow.

Cool. If we can solve the auto-update-website part, then we ought to be able to solve the broken links by simply updating them.

> Have a nice weekend, and get some rest - you need to
> be fresh when the child will have arrived :-)

:). I've been going to bed around 8:30pm. Doing my best to stay well rested. I just know he'll decide to come sometime in the middle of the night.

Cheers
Richard

Patrick Wright

Hi Richard

Nice job on the new website, saw that a few weeks ago, looks good.

Does the server hosting swinglabs.org support any programming, dynamic
languages or JSP? Could be nice for some of the documentation, or
demos, etc.

Regards
Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

rbair
Offline
Joined: 2003-07-08
Points: 0

Hey Patrick,

Yep, the entire webapp is JSP based right now. So... we can pretty much do anything we want. For example, I have a tutorial engine that takes an XML file and generates the tutorial page(s) out of it. All very rough, mind you, but it does open up some possibilities.

That's one reason I've wanted to move the content onto SwingLabs.org rather than simply linking back to the various subprojects. On SwingLabs.org we can have a (nice looking) consistent format for documentation, tutorials, HOWTO's, FAQs, etc.

Richard