Re: New Doc space

From: Cris Daniluk (cris.danilu..mail.com)
Date: Wed Feb 08 2006 - 10:36:48 EST

  • Next message: Ahmed Mohombe: "Re: WIKI changes"

    I have completed the first two sections... the automated stuff is
    going to take as long to fix as just cutting and pasting, so after
    tinkering a bit I decided to go manual :)

    I've created "User Guide" underneath the documentation section, so we
    can maintain the Modeler Guide, maybe move the cookbook and tutorials
    under there, etc. Please don't mind sections being out of order right
    now. I'm letting Confluence auto-generate the contents right now to
    make sure we don't miss anything. After, we can go in and re-establish
    a natural ordering.

    Let me know what you guys think before I go any further. I think it
    looks great so far.

    Cris

    On 2/7/06, Gentry, Michael (Contractor) <michael_gentr..anniemae.com> wrote:
    > That's cool, too. You are more familiar with the workings of Confluence
    > than me. We can always put references to the other documentation spaces
    > on the main documentation page.
    >
    > /dev/mrg
    >
    >
    >
    > -----Original Message-----
    > From: Andrus Adamchik [mailto:andru..bjectstyle.org]
    > Sent: Tuesday, February 07, 2006 3:40 PM
    > To: cayenne-deve..bjectstyle.org
    > Subject: Re: New Doc space
    >
    >
    > I guess the idea is that there is no release mixing within one space.
    > In other words a space is a branch.
    >
    > CAYDOC Space == HEAD in CVS
    > CAYDOC## Space == STABLE-## branch in CVS
    >
    > In the future when we branch 1.2 to STABLE-1.2, we will
    > simultaneously create a copy of CAYDOC to a new CAYDOC12 space, and
    > will continue new doc work in CAYDOC.
    >
    > Also it doesn't make sense now to port back 1.1 docs in its own
    > space, so I suggest we start with HEAD version of the docs.
    >
    > Andrus
    >
    >
    > On Feb 7, 2006, at 3:33 PM, Gentry, Michael ((Contractor)) wrote:
    >
    > > Should we have "Cayenne 1.1" and "Cayenne 1.2" top-level folders?
    > >
    > >
    > >
    > > -----Original Message-----
    > > From: Andrus Adamchik [mailto:andru..bjectstyle.org]
    > > Sent: Tuesday, February 07, 2006 3:30 PM
    > > To: cayenne-deve..bjectstyle.org
    > > Subject: New Doc space
    > >
    > >
    > > I just created a new CAYDOC space. It has the same permissions as CAY
    > > space.
    > >
    > > http://objectstyle.org/confluence/display/CAYDOC/Home
    > >
    > > Would anyone volunteer to convert our XML docs from CVS to Confluence
    > > format and load them in?
    > >
    > > There is already a Velocity template that converts XML to HTML under
    > > cayenne-other/xdocs/stylesheets/cayenne.vsl. I hope it can be tweaked
    > > to generate much simpler confluence markup.
    > >
    > > Andrus
    > >
    > >
    > > On Feb 7, 2006, at 2:44 PM, Cris Daniluk wrote:
    > >
    > >> On 2/7/06, Andrus Adamchik <andru..bjectstyle.org> wrote:
    > >>>
    > >>> On Feb 7, 2006, at 1:52 PM, Cris Daniluk wrote:
    > >>>
    > >>>> We talked about this a while ago, but it kind of fizzled out I
    > >>>> think... maybe its time to move the documentation into the wiki.
    > >>>> WebWork does it in a separate space and exports the space to HTML
    > >>>> for
    > >>>> each release, so that you have "versioned" documentation. I
    > >>>> think it
    > >>>> would be worth considering starting a space in the wiki to do just
    > >>>> this.
    > >>>
    > >>> I am still entertaining this idea... How do they handle two branches
    > >>> of documentation? What if we have to do releases of say 1.2 and 2.0
    > >>> in parallel for some time. I guess once a stable release is
    > >>> branched,
    > >>> we can copy the entire space to a separate "branch" space, and keep
    > >>> the main doc space up to date with HEAD?
    > >>>
    > >> I think copying the space would be the way to go. There's page level
    > >> versioning, but no space-level tagging/branching that would allow us
    > >> to concurrently manage the documentation in the same space.
    > >> Copying is
    > >> pretty simple though, and major releases don't happen often.
    > >>
    > >
    > >
    >
    >



    This archive was generated by hypermail 2.0.0 : Wed Feb 08 2006 - 10:36:49 EST