I envision this process being similar to WebWork - a static export is
done (once we get the toc working right) as part of the ant release
process. Thus, the wiki docs represent "CVS" while the version
distributed with the release correlate to that. Additionally, the
non-wiki docs on the website (which do not currently exist) would
match the most current "stable" release.
The only thing tricky about the wiki docs matching CVS is in a
branching environment. We discussed that before, though. The consensus
was that we could copy the space for a branch, so that the "doc
branch" stays up to date with the CVS branch.
Anyway, to sum it up - improvements are good and won't stomp on my
toes at all. We haven't put together conventions yet, but I would like
to recommend putting classes in {{}}'s (monospaced) whenever new docs
are written. This may end up being the way I can handle javadocs,
rather than bringing in another notation to remember.
Cris
On 3/7/06, Andrus Adamchik <andru..bjectstyle.org> wrote:
> Yeah, bringing the docs up to date is totally OK, and is actually
> something we need to be doing now. Cris is just asking to avoid doing
> JavaDoc linking to the site.
>
> Andrus
>
>
> On Mar 7, 2006, at 4:00 PM, Kevin Menard wrote:
>
> > I'm fine with it, but you better okay with Cris, since this is his
> > turf ;-)
> >
> > Now, what's the deal with updating the docs? Obviously the Wiki
> > can be updated more frequently than code releases. Should we not
> > be doing that? The reason I ask is that the original modeler docs
> > had a lot of holes that I intend on filling and other stuff that
> > just needs to be updated. I don't want to be ripping docs out from
> > under people's feet, but I'd imagine enhancements aren't a problem,
> > correct?
> >
> > --
> > Kevin
> >
> > On Tue, 07 Mar 2006 05:05:06 -0500, Andrus Adamchik
> > <andru..bjectstyle.org> wrote:
> >
> >> Cris, Kevin --
> >>
> >> I just finished the first cut of the nested DataContext commit
> >> functionality and wanted to make a release. I was wondering how
> >> close are we to using CAYDOC Wiki space for release documentation.
> >> I recall we had these unresolved issues:
> >>
> >> 1. Smart hyperlinking to JavaDocs (IMO we can ship the docs with
> >> this not fully resolved),
> >> 2. Table of Contents. We want it to be off for the PDF export and
> >> on for the HTML. I guess we can go with PDF only option in M12
> >> (and temporarily remove sample ToC from the Deployment section)??
> >> 3. ... anything else I am missing??
> >>
> >> An unrelated question. Cris, I was going to merge all stuff under
> >> here:
> >>
> >> http://objectstyle.org/confluence/display/CAY/1.2+User+Guide
> >>
> >> to CAYDOC user guide. Wanted to check if this would interfere with
> >> your work and whether I should hold it off for now.
> >>
> >> Andrus
> >
> >
> >
>
>
This archive was generated by hypermail 2.0.0 : Tue Mar 07 2006 - 09:01:16 EST