Mailing List Archive: Apache: Docs

Doing the main site first (was Re: Proposal to move docs to Apache CMS)

Index | Next | Previous | View Threaded

joe_schaefer at yahoo

May 5, 2012, 8:02 AM

Post #1 of 4 (179 views)
Permalink

Doing the main site first (was Re: Proposal to move docs to Apache CMS)

Speaking with Daniel on IRC this morning convinced
me that pushing for docs CMS adoption at this point
remains a hard sell. We both agreed that migrating
the main site first to the CMS would be better for all
concerned, so let's go that route for now and come back
to docs once everyone has had a chance to play with
the CMS on a production site that they actually care about.

Since the site is a standard Anakia thingy, we have
migration tools that will convert the xml to markdown,
and I talked Daniel into coming up with a simple django
template for the site. That means we can use the CMS's
standard perl build stuff instead of the largeish collection
of java utils that generate the html- its a whole lot
simpler and faster in practice once the docs have been
migrated.

We can leave any .html and .txt documents as-is, they
won't be changed by the build. Another thing I'd like
to see us do is move the download.cgi script out of the
doctree and into a separate cgi-bin/ dir, just so we can
actually practice what we preach ;-). The CMS fully
supports that.

Anyhow if we can find consensus on this plan we can take
this back to dev@ and look for general approval.

Thoughts?

>________________________________
> From: Joe Schaefer <joe_schaefer [at] yahoo>
>To: "docs [at] httpd" <docs [at] httpd>
>Sent: Friday, May 4, 2012 3:22 PM
>Subject: Re: Proposal to move docs to Apache CMS
>
>
>IME it's a bit of a challenge to get CMS users
>to pay attention to the build output, even tho
>we provide links to the build in question, so
>if we can validate on form submission it will
>work out a bit better.
>
>
>
>
>
>>________________________________
>> From: Rich Bowen <rbowen [at] rcbowen>
>>To: docs [at] httpd; Joe Schaefer <joe_schaefer [at] yahoo>
>>Sent: Friday, May 4, 2012 3:19 PM
>>Subject: Re: Proposal to move docs to Apache CMS
>>
>>
>>
>>
>>On May 4, 2012, at 3:04 PM, Joe Schaefer wrote:
>>
>>It'll be interesting to see how codemirror2 handles
>>>the custom character entities in the httpd docs, but assuming
>>>it doesn't choke there's probably an option to validate
>>>the XML before allowing it to be submitted to the server.
>>>
>>>I doubt that's currently turned on, but if the code
>>>does the right thing I might be convinced to enable it.
>>
>>
>>Our build script does validation as part of the build process, too.
>>
>>--
>>Rich Bowen
>>rbowen [at] rcbowen :: @rbowen
>>rbowen [at] apache
>>
>>
>>
>>
>>
>>
>>
>>
>>
>
>

rbowen at rcbowen

May 5, 2012, 11:31 AM

Post #2 of 4 (171 views)
Permalink

Re: Doing the main site first (was Re: Proposal to move docs to Apache CMS) [In reply to]

On May 5, 2012, at 11:02 AM, Joe Schaefer wrote:

> Speaking with Daniel on IRC this morning convinced
> me that pushing for docs CMS adoption at this point
> remains a hard sell. We both agreed that migrating
> the main site first to the CMS would be better for all
> concerned, so let's go that route for now and come back
> to docs once everyone has had a chance to play with
> the CMS on a production site that they actually care about.
>
> Since the site is a standard Anakia thingy, we have
> migration tools that will convert the xml to markdown,
> and I talked Daniel into coming up with a simple django
> template for the site. That means we can use the CMS's
> standard perl build stuff instead of the largeish collection
> of java utils that generate the html- its a whole lot
> simpler and faster in practice once the docs have been
> migrated.
>
> We can leave any .html and .txt documents as-is, they
> won't be changed by the build. Another thing I'd like
> to see us do is move the download.cgi script out of the
> doctree and into a separate cgi-bin/ dir, just so we can
> actually practice what we preach ;-). The CMS fully
> supports that.
>
> Anyhow if we can find consensus on this plan we can take
> this back to dev@ and look for general approval.

Yes, this is the right way to go as a first step. +1

--
Rich Bowen
rbowen [at] rcbowen :: @rbowen
rbowen [at] apache

rumble at cord

May 6, 2012, 5:53 AM

Post #3 of 4 (171 views)
Permalink

Re: Doing the main site first (was Re: Proposal to move docs to Apache CMS) [In reply to]

On 05-05-2012 17:02, Joe Schaefer wrote:
> Speaking with Daniel on IRC this morning convinced
> me that pushing for docs CMS adoption at this point
> remains a hard sell. We both agreed that migrating
> the main site first to the CMS would be better for all
> concerned, so let's go that route for now and come back
> to docs once everyone has had a chance to play with
> the CMS on a production site that they actually care about.
>
> Since the site is a standard Anakia thingy, we have
> migration tools that will convert the xml to markdown,
> and I talked Daniel into coming up with a simple django
> template for the site. That means we can use the CMS's
> standard perl build stuff instead of the largeish collection
> of java utils that generate the html- its a whole lot
> simpler and faster in practice once the docs have been
> migrated.
>
> We can leave any .html and .txt documents as-is, they
> won't be changed by the build. Another thing I'd like
> to see us do is move the download.cgi script out of the
> doctree and into a separate cgi-bin/ dir, just so we can
> actually practice what we preach ;-). The CMS fully
> supports that.
>
> Anyhow if we can find consensus on this plan we can take
> this back to dev@ and look for general approval.
>
> Thoughts?
>

+1 to that, obviously, since I'm working on a template already. It's
located at http://httpd.humbedooh.com/cms/trunk/ by the way, in case
anyone wants to snoop. And if you do, you'll see that it's quite simple
to migrate, as all we need to do is convert our existing pages into
markdown via the anakia2markdown script (
https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/anakia2markdown.xslt
) and add them to the content directory, and the CMS will take care of
building and what not. A little grunt work is expected, in order to make
the pages conform completely, but as we have so few pages on our main
site, it's really of no concern.

I would, of course, suggest we first set up some form of testing area,
so we can try wrapping our heads around it and get it working before we
migrate completely :)

With regards,
Daniel.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe [at] httpd
For additional commands, e-mail: docs-help [at] httpd

joe_schaefer at yahoo

May 6, 2012, 7:30 AM

Post #4 of 4 (171 views)
Permalink

Re: Doing the main site first (was Re: Proposal to move docs to Apache CMS) [In reply to]

>________________________________
> From: Daniel Gruno <rumble [at] cord>
>To: docs [at] httpd
>Sent: Sunday, May 6, 2012 8:53 AM
>Subject: Re: Doing the main site first (was Re: Proposal to move docs to Apache CMS)
>
>On 05-05-2012 17:02, Joe Schaefer wrote:
>> Speaking with Daniel on IRC this morning convinced
>> me that pushing for docs CMS adoption at this point
>> remains a hard sell. We both agreed that migrating
>> the main site first to the CMS would be better for all
>> concerned, so let's go that route for now and come back
>> to docs once everyone has had a chance to play with
>> the CMS on a production site that they actually care about.
>>
>> Since the site is a standard Anakia thingy, we have
>> migration tools that will convert the xml to markdown,
>> and I talked Daniel into coming up with a simple django
>> template for the site. That means we can use the CMS's
>> standard perl build stuff instead of the largeish collection
>> of java utils that generate the html- its a whole lot
>> simpler and faster in practice once the docs have been
>> migrated.
>>
>> We can leave any .html and .txt documents as-is, they
>> won't be changed by the build. Another thing I'd like
>> to see us do is move the download.cgi script out of the
>> doctree and into a separate cgi-bin/ dir, just so we can
>> actually practice what we preach ;-). The CMS fully
>> supports that.
>>
>> Anyhow if we can find consensus on this plan we can take
>> this back to dev@ and look for general approval.
>>
>> Thoughts?
>>
>
>+1 to that, obviously, since I'm working on a template already. It's
>located at http://httpd.humbedooh.com/cms/trunk/ by the way, in case
>anyone wants to snoop. And if you do, you'll see that it's quite simple
>to migrate, as all we need to do is convert our existing pages into
>markdown via the anakia2markdown script (
>https://svn.apache.org/repos/infra/websites/cms/conversion-utilities/anakia2markdown.xslt
>) and add them to the content directory, and the CMS will take care of
>building and what not. A little grunt work is expected, in order to make
>the pages conform completely, but as we have so few pages on our main
>site, it's really of no concern.
>
>I would, of course, suggest we first set up some form of testing area,
>so we can try wrapping our heads around it and get it working before we
>migrate completely :)

Now that everything's in svn I've gone ahead and activated the CMS for
httpd (sans production). The staging site is available at

http://httpd.staging.apache.org/

Once we're satisfied that everything's ready to go live, we'll vote ;-).

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe [at] httpd
For additional commands, e-mail: docs-help [at] httpd

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads