Mailing-List: contact rat-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: rat-dev@incubator.apache.org
Received-SPF: pass (nike.apache.org: domain of david.blevins@gmail.com
 designates 209.85.210.175 as permitted sender)
Content-Type: text/plain; charset=iso-8859-1
Mime-Version: 1.0 (Apple Message framework v1251.1)
Subject: Re: CMS staging setup
From: David Blevins <david.blevins@gmail.com>
In-Reply-To: <4EFDBCF7.5090904@blueyonder.co.uk>
Date: Tue, 10 Jan 2012 22:25:06 -0800
Content-Transfer-Encoding: quoted-printable
Message-Id: <66FEE43C-FB9B-4C23-A0AE-620F54BAD632@gmail.com>
References: <9C4FB2FB-A656-4F18-B9BE-9F7EFCFEFE48@gmail.com>
 <4EFC295B.6080300@blueyonder.co.uk>
 <88CC3217-7545-448D-AA25-49B574E92E3C@gmail.com>
 <4EFCA8E8.5030507@blueyonder.co.uk>
 <5235D1B0-88C8-497C-BE28-6F646093E8A6@gmail.com>
 <4EFDBCF7.5090904@blueyonder.co.uk>
To: rat-dev@incubator.apache.org


On Dec 30, 2011, at 5:30 AM, Robert Burrell Donkin wrote:

> On 12/29/11 20:34, David Blevins wrote:
>>=20
>> On Dec 29, 2011, at 9:52 AM, Robert Burrell Donkin wrote:
>>=20
>>> On 12/29/11 16:51, David Blevins wrote:
>>>>=20
>>>> On Dec 29, 2011, at 12:48 AM, Robert Burrell Donkin wrote:
>>>>=20
>>>>>> In terms of quick and easy converting we could just take all the =
existing html files=20
>>>>>> and check them into the 'rat/site/trunk/content/rat/' directory =
of svn. =20
>>>>>> Then we just let Joe know we're ready and he sets up the actual =
production publishing.
>>>>>=20
>>>>> The content at http://incubator.apache.org/rat is generated by =
Maven, is
>>>>> developer-oriented and describes only classic rat.
>>>>>=20
>>>>> Now we have CMS, IMHO creating new, user-oriented top level
>>>>> documentation covering all the suite would make sense, with =
developer
>>>>> documentation generated by Maven in subdirectories.
>>>>=20
>>>> So something like this?
>>>>=20
>>>> rat/ (the root)
>>>>  rat/(main "rat the tool" section)
>>>>     maven/
>>>>  whisker/
>>>>     maven/
>>>>  eye/
>>>>     maven/
>>>>  scan/
>>>>     maven/
>>>>  tentacles/
>>>>     maven/
>>>=20
>>> (Not quite what I had in mind but) works for me :-)
>>=20
>> If you can "sketch" out what you were thinking that'd be great.  The =
above is maybe a little tedious.
>=20
> I hadn't really given the matter much thought, so let's start from =
that
> suggestion...
>=20
> IMHO we should allow tools to pick the most appropriate tool for them.
> So, renaming maven -> docs would provide space for generated
> documentation of any sort:
>=20
> rat/
>  rat/
>    docs/ <- generated by Maven
>  whisker/
>    docs/ <- generated by Maven
>  eye/
>    docs/ <- generated by Python?
>  scan/
>    docs/ <- ??
>  tentacles/
>    docs/ <-generated by Maven?
>=20
> Whisker is a build tool extension. Maven sites work well for this sort
> of component. My inclination would be to HTTP redirect rat/whisker ->
> rat/whisker/docs and maintain the Whisker documentation only in Maven.

I tar'ed and scp'ed over the current site contents with the intent of =
checking them in, but they turned out to be 27MB uncompressed.  Looks =
like most of that is duplication -- guessing at one point things were =
'rat-foo' and then were switched to 'apache-rat-foo'.

Tried grabbing the source and generating the site, but didn't have any =
luck -- never actually used the mvn site plugin.  Not sure if I was =
missing some params.

If someone already setup to build the various sites gives it a whirl =
that'd be great.  Maybe the primary person(s) of each subproject can =
give it a whirl.  We probably just need the main rat content in there to =
switch over fully to the CMS.  The rest can come as people get free =
time.

Fairly straightforward svn add/ci.  Just need to 'svn add' the content =
in these dirs:

  =
https://svn.apache.org/repos/asf/incubator/rat/site/trunk/content/rat/rat
  =
https://svn.apache.org/repos/asf/incubator/rat/site/trunk/content/rat/whis=
ker
  =
https://svn.apache.org/repos/asf/incubator/rat/site/trunk/content/rat/eye
  =
https://svn.apache.org/repos/asf/incubator/rat/site/trunk/content/rat/scan=


We could add the docs subdirs and the redirects leaving the parent dir =
empty, but certainly we don't need that for any CMS reasons.  It'll be =
happy either way.


-David