gora-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Lewis John Mcgibbney <lewis.mcgibb...@gmail.com>
Subject Re: Gora site docs
Date Thu, 19 Jan 2012 13:51:38 GMT
I would like to see this all handled by Maven as it's really clean that
way. It's working a treat on another project I'm working on and it would be
great to get that same functionality @ Gora. The problem is (as you
mention) that were currently storing docs @ 2 locations... so a solution
would need to be coined to address this. We also have some problems just
now with links or servers or something which needs to be sorted out as the
links to the release dependent docs e.g. theones which ship with Gora:
tutorial etc are broken. I would have liked to get on this but I've not had
2 mins recently to dig in to it.

On Thu, Jan 19, 2012 at 1:29 PM, Henry Saputra <henry.saputra@gmail.com>wrote:

> Are you thinking about changing both the docs for per-release and the
> independent docs to maven-site-plugin or just the per-release?
>
> - Henry
>
> On Tue, Jan 17, 2012 at 7:35 AM, Lewis John Mcgibbney
> <lewis.mcgibbney@gmail.com> wrote:
> > Ok Guys having not heard a bean back regarding the CMS, I propose to use
> > the maven-site-plugin to generate the site code. Thsi makes it a piece of
> > cake to edit, author and publish our site docs.
> >
> > Do we already have site docs available under /people.apache.org?
> >
> > <plugin>
> > <groupId>org.apache.maven.plugins</groupId>
> > <artifactId>maven-site-plugin</artifactId>
> > <version>3.0</version>
> > -
> > <dependencies>
> > -
> > <dependency>
> > <groupId>org.apache.maven.wagon</groupId>
> > <artifactId>wagon-ssh</artifactId>
> > <version>1.0</version>
> > </dependency>
> > </dependencies>
> > -
> > <configuration>
> > -
> > <stagingSiteURL>
> > scp://people.apache.org/www/incubator.apache.org/gora/${project.version}<http://people.apache.org/www/incubator.apache.org/gora/$%7Bproject.version%7D>
> > </stagingSiteURL>
> > </configuration>
> > </plugin>
> >
> > On Tue, Jan 3, 2012 at 10:14 PM, Lewis John Mcgibbney <
> > lewis.mcgibbney@gmail.com> wrote:
> >
> >> Hi Enis,
> >>
> >> It would be great to sort this out shortly after we hear the
> >> Graduation outcome, I am happy to work towards addressing all of the
> >> open documentation Jira issues under this umbrella issue, however I'm
> >> also of the opinion that we should make life as easy as possible to
> >> work with the documentation.
> >>
> >> In addition, depending on the outcome of the Graduation, we will
> >> probably need to revamp the entire Gora site docs anyway. Having read
> >> the link you provided, my own opinion is weighted towards migrating to
> >> the new CMS proposed. Although this means a bit more work initially,
> >> it will also mean that we are able to begin afresh and really get on
> >> top of it.
> >>
> >> Does anyone on the team have any experience migrating content to the
> >> new CMS? I know a couple of people I can get in touch with to get up
> >> to speed with this but it would be great to hear some input from the
> >> wider Gora dev team.
> >>
> >> Thanks for now
> >>
> >> Lewis
> >>
> >>
> >>
> >> On Wed, Dec 28, 2011 at 8:29 PM, Enis Söztutar <enis.soz@gmail.com>
> wrote:
> >> > Hi Lewis,
> >> >
> >> > I guess, the links to the release-specific docs are broken, due to the
> >> new
> >> > svnpubsub script releasing the changes to the site. The easiest way I
> >> think
> >> > is to commit the 0.1.1 release docs under
> /site/docs/r0.1.1-incubating/
> >> and
> >> > point /current to it.
> >> >
> >> > Another option can be to switch to Maven for building the site docs,
> or
> >> use
> >> > the confluence wiki as our main web page, and move all the current
> >> content
> >> > there.
> >> >
> >> > see https://www.apache.org/dev/cms.html
> >> >
> >> > Thanks,
> >> > Enis
> >> >
> >> > On Tue, Dec 27, 2011 at 9:13 AM, Lewis John Mcgibbney <
> >> > lewis.mcgibbney@gmail.com> wrote:
> >> >
> >> >> Hi Guys,
> >> >>
> >> >> Whilst addressing GORA-71, it has been drawn to my attention that the
> >> >> link to the per-release docs [1] is broken!
> >> >>
> >> >> Any ideas what is wrong?
> >> >>
> >> >> Thanks
> >> >>
> >> >> Lewis
> >> >>
> >> >> [1] https://svn.apache.org/viewvc/incubator/gora/trunk/docs/
> >> >>
> >> >> On Thu, Oct 27, 2011 at 1:14 AM, Enis Söztutar <enis.soz@gmail.com>
> >> wrote:
> >> >> > Hi Lewis,
> >> >> >
> >> >> > The site docs at Gora are in two places, release independent docs
> are
> >> at
> >> >> > [1], and per-release docs are at [2]. The reasoning is that, the
> >> >> per-release
> >> >> > docs contain the release-specific information (like Javadoc,
> tutorial,
> >> >> etc),
> >> >> > and this documentation is distributed at the tar ball, and everyone
> >> >> should
> >> >> > be able to build and use the docs locally. Release independent
docs
> >> >> contain
> >> >> > the regular site information.
> >> >> >
> >> >> > So, with that said, the release-independent docs are deployed
at
> the
> >> root
> >> >> > directory (http://i.a.o/gora/), and every release doc should go
> under
> >> >> it's
> >> >> > release number (like http://i.a.o/gora/docs/r0.1-incubating/),
and
> >> >> finally,
> >> >> > docs for trunk goes under http://i.a.o/gora/docs/current/. For
> >> >> deploying the
> >> >> > site at people.apache.org, we just check out rendered pages at
> [1],
> >> and
> >> >> > check out [2] under /docs/current/ and for each release, we create
> a
> >> >> > directory under /docs/, and check out the docs for that release,
so
> >> that
> >> >> the
> >> >> > site contains /docs/current/, /docs/r0.1-incubating,
> >> >> > /docs/r0.1.1-incubating, etc.
> >> >> >
> >> >> > [1] https://svn.apache.org/viewvc/incubator/gora/site/
> >> >> > [2] https://svn.apache.org/viewvc/incubator/gora/trunk/docs/
> >> >> >
> >> >> > Coming to your question, the references that you asked about in
> >> forrest
> >> >> for
> >> >> > the release-independent docs are links to per-release docs under
> [2].
> >> >> >
> >> >> > Hope this answers your question. Let me know otherwise.
> >> >> > Enis
> >> >> >
> >> >> > On Wed, Oct 26, 2011 at 1:51 PM, lewis john mcgibbney <
> >> >> > lewis.mcgibbney@gmail.com> wrote:
> >> >> >
> >> >> >> Hi,
> >> >> >>
> >> >> >> I think this is aimed mainly towards Enis but I'm not sure,
can
> >> someone
> >> >> >> please tell me where I can find the following
> >> >> >>
> >> >> >>    <docs href="http://incubator.apache.org/gora/docs/">
> >> >> >>      <current href="current/">
> >> >> >>        <index href="index.html"/>
> >> >> >>        <quickstart href="quickstart.html"/>
> >> >> >>        <gora-core href="gora-core.html"/>
> >> >> >>        <gora-cassandra href="gora-cassandra.html"/>
> >> >> >>        <gora-hbase href="gora-hbase.html"/>
> >> >> >>        <gora-sql href="gora-sql.html"/>
> >> >> >>      </current>
> >> >> >>   </docs>
> >> >> >>
> >> >> >> Just so I can begin working on upgrading the missing site
docs as
> per
> >> >> the
> >> >> >> Jira tickets I filed a while ago (and forgot about).
> >> >> >>
> >> >> >> Thank you
> >> >> >>
> >> >> >> --
> >> >> >> *Lewis*
> >> >> >>
> >> >>
> >> >>
> >> >>
> >> >> --
> >> >> Lewis
> >> >>
> >>
> >>
> >>
> >> --
> >> Lewis
> >>
> >
> >
> >
> > --
> > *Lewis*
>



-- 
*Lewis*

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message