Is everyone okay with me adding the following to the site on the left hand menu:
<a href="docs/ruby" title="Everything you need to run iBATIS for Ruby (aka RBatis)">for Ruby/Rails (prerelease)</a><br/> The link currently just goes to http://ibatis.apache.org/docs/ruby which is the automatically generated RDoc API documentation. It does contain instructions on how to download, install and getting started though. (This is common practice in the Ruby world.) Oh, another thing: We currently have a Rails plugin which is great for Rails users, for users outside Rails we need something called a "Gem". It kinda works a bit like Maven or Ports as in they are automatically downloaded and installed. They are distributed from Rubyforge. The easiest way to get full access to deploying a gem on Rubyforge is by registering a project at Rubyforge for RBatis. Would there be any problems around doing that? Cheers, Jon On 7/20/06, Clinton Begin <[EMAIL PROTECTED]> wrote:
Yes, Jeff sent an email describing the docs structure. As below: VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVV Hi All, I know Clinton has some ideas for restructuring the site now that the Ruby content is getting close. My main interest is in getting some additional documentation for Abator published. So, I'm wondering what you all think of a docs structure like this: /docs/dotnet/docs/java /docs/ruby /docs/tools/abator These would each be "top level" directories, the different projects could structure as needed under their directory. Any other stuff that I've forgotten? This would mean that the site would be structured like this: / - the existing site /dtd - existing dtd directory, must not be disturbed when the site is regenerated /docs - new top level docs directory with subdirectories as above, must not be disturbed when the site is regenerated /tools/abator - existing directory that is serving the Eclipse update site for Abator, must not be disturbed when the site is regenerated The only thing I'm proposing to add to what's already there are the different docs directories. And I guess the only thing I really have to add right now is /docs/tools/abator. Anyone have objections or other ideas? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On 7/19/06, Jon Tirsen < [EMAIL PROTECTED]> wrote: > I've got a bunch of rdoc (equivalent to JavaDoc) API documentation I > would like to deploy as well. Can I have completely unstyled content > as well? > > Cheers, > Jon > > On 7/20/06, Clinton Begin <[EMAIL PROTECTED]> wrote: > > Yeah, > > > > Basically the site development paradigm (our favourite word) should be > > familiar to you. We use plain old HTML/XHTML with StaticMesh for theming. > > You can edit any of the pages which might be .html of .vm (velocity macro) > > files. There's no magic to it. > > > > Once you've edited it, use the build.bat (Ant script) to generate the site > > to the the /deploy directory. > > > > But definitely read Jeff's docs. They'll ensure you don't blow anything > > away. :-) > > > > Clinton > > > > > > On 7/19/06, Jeff Butler <[EMAIL PROTECTED]> wrote: > > > > > > > > > Hi Jon, > > > > > > That took me a while to figure out too! > > > > > > I've just updated the WIKI page about this with more current information: > > > > > > > > http://opensource.atlassian.com/confluence/oss/display/IBATIS/Updating+the+Website > > > > > > My opinion is that you should add a high level page linked under the > > "Downloads and Documentation" section that describes the new version (BTW - > > woo hoo!). Then you can add detailed documentation under the /docs/ruby > > directory. You can structure and generate those pages any way you desire. > > > > > > > > > Jeff Butler > > > > > > > > > > > > On 7/19/06, Jon Tirsen < [EMAIL PROTECTED]> wrote: > > > > I'm finally getting the RBatis website together. Forgive me for asking > > > > a newbie question, but: Where is the current iBatis website? How do I > > > > go about changing it? How do I redeploy it? Any thoughts were I should > > > > put the RBatis material? > > > > > > > > Cheers, > > > > Jon > > > > > > > > > > > > > > >
