You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by Howard Lewis Ship <hl...@gmail.com> on 2012/08/01 21:15:59 UTC
Time to switch from Confluence to CMS
I think it's time that we switch over from Confluence to the CMS
http://www.apache.org/dev/cms.html
Looks like the CMS is going to be SVN regardless
I'm hoping someone can volunteer to spearhead this; if not, I'll look
into it in a week or so.
The docs kind of presume a lot of knowledge of some version of Django,
which I certainly don't have.
I think markdown will be a fine format. I like that it will be
possible to navigate to a page and click an edit button. It should be
possible to open up our site repo to any Apache committer.
I'm not quite sure what we'll do about published JavaDocs (and,
potentially, other reports, such as JavaScript/CoffeeScript docs).
Possibly, we'll need to generate those into an SVN folder and check
them into SVN for publishing to the site.
I'm hoping the result will be something faster and easier to maintain,
and more customizable as well.
--
Howard M. Lewis Ship
Creator of Apache Tapestry
The source for Tapestry training, mentoring and support. Contact me to
learn how I can get you up and productive in Tapestry fast!
(971) 678-5210
http://howardlewisship.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Carsten Klein <ca...@axn-software.de>.
> I think it's time that we switch over from Confluence to the CMS
>
> http://www.apache.org/dev/cms.html
>
> Looks like the CMS is going to be SVN regardless
>
Something Github adopted for their project wikis.
> I'm hoping someone can volunteer to spearhead this; if not, I'll look
> into it in a week or so.
As I am not an Apache Comitter, you might not count me in on this, but I
could assist you in the process, if you like.
>
> The docs kind of presume a lot of knowledge of some version of Django,
> which I certainly don't have.
>
AFAIK it is about the markup being used for templating. The implementation
itself seems to be in PERL -- see the mod-perl reference *sic*.
> I'm not quite sure what we'll do about published JavaDocs (and,
> potentially, other reports, such as JavaScript/CoffeeScript docs).
> Possibly, we'll need to generate those into an SVN folder and check
> them into SVN for publishing to the site.
As the docs go, one can package them using targz and then publish the
archive to the CMS, but I have not read into that any further.
> I'm hoping the result will be something faster and easier to maintain,
> and more customizable as well.
Hm, how about using the maven site plugin? *duck*...
Regards,
Carsten
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Howard Lewis Ship <hl...@gmail.com>.
On Wed, Aug 1, 2012 at 4:29 PM, Ulrich Stärk <ul...@spielviel.de> wrote:
> I suggest doing a migration to svnpubsub first and switch to Markdown or whatever else we want to
> use for documentation generation later. It's the autoexport that's going away, not Confluence itself.
>
How would that work? Edit on Confluence, sure, but then what? How
would the Confluence content get exported as HTML so that svnpubsub
can publish?
> Also, we won't need any Django knowledge. The CMS' architecture might be influenced by Django but
> you certainly don't need to know anything about it in order to work with the CMS.
There's a bit of configuration that seems to be used to match source
documents to the correct template, based primarily on containing
folder.
>
> Automatically generated source code documentation might indeed be a problem. We should find out how
> other projects are doing this. I don't like the idea of checking it back into SVN as part of the
> build process.
>
> Uli
>
> On 01.08.2012 21:15, Howard Lewis Ship wrote:
>> I think it's time that we switch over from Confluence to the CMS
>>
>> http://www.apache.org/dev/cms.html
>>
>> Looks like the CMS is going to be SVN regardless
>>
>> I'm hoping someone can volunteer to spearhead this; if not, I'll look
>> into it in a week or so.
>>
>> The docs kind of presume a lot of knowledge of some version of Django,
>> which I certainly don't have.
>>
>> I think markdown will be a fine format. I like that it will be
>> possible to navigate to a page and click an edit button. It should be
>> possible to open up our site repo to any Apache committer.
>>
>> I'm not quite sure what we'll do about published JavaDocs (and,
>> potentially, other reports, such as JavaScript/CoffeeScript docs).
>> Possibly, we'll need to generate those into an SVN folder and check
>> them into SVN for publishing to the site.
>>
>> I'm hoping the result will be something faster and easier to maintain,
>> and more customizable as well.
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
--
Howard M. Lewis Ship
Creator of Apache Tapestry
The source for Tapestry training, mentoring and support. Contact me to
learn how I can get you up and productive in Tapestry fast!
(971) 678-5210
http://howardlewisship.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Ulrich Stärk <ul...@spielviel.de>.
-1
There must be some other way. And if all else fails we will just check them in.
Uki
Am 02.08.2012 um 23:01 schrieb "Thiago H de Paula Figueiredo" <th...@gmail.com>:
> On Thu, 02 Aug 2012 12:11:30 -0300, Howard Lewis Ship <hl...@gmail.com> wrote:
>
>> Maybe host the JavaDoc it off-apache? We could use my
>> howardlewisship.com site, or go register tapestrydocs.net or
>> something.
>
> tapestry.com.br is mine and can be used for that.
>
> --
> Thiago H. de Paula Figueiredo
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Bob Harner <bo...@gmail.com>.
By the way, we have always had the ability to add an "Edit" button to
pages on the published site. Just look at the "edit page" link at the
bottom of http://camel.apache.org/ as an example. We just need to
modify our Velocity template to do that.
On Thu, Aug 2, 2012 at 9:06 PM, Bob Harner <bo...@gmail.com> wrote:
> I have assumed I would be spending a bunch of time on this in the
> second half of 2012 and am willing to get started now. But I was
> hoping Uli was already working on it and just needs some help :-)
>
> I believe Uli is talking about the approach described at
> http://www.dankulp.com/blog/2012/03/svnpubsub-for-confluence-sites/,
> which I agree is the obvious way for us to proceed, at least for a
> while. It allows us to keep our high-quality documentation intact with
> little disruption. Any other approach (converting to another content
> editing system, with a different markup language) will likely require
> thousands of manual content tweaks of the sort that was done when the
> docs were first moved *into* Confluence.
>
> As for the javadocs, I'm wondering why there is talk of moving them.
> What's wrong with the current process there?
>
>>> I like that it will be possible to navigate to a page and click an edit button.
>
> On Thu, Aug 2, 2012 at 5:01 PM, Thiago H de Paula Figueiredo
> <th...@gmail.com> wrote:
>> On Thu, 02 Aug 2012 12:11:30 -0300, Howard Lewis Ship <hl...@gmail.com>
>> wrote:
>>
>>> Maybe host the JavaDoc it off-apache? We could use my
>>> howardlewisship.com site, or go register tapestrydocs.net or
>>> something.
>>
>>
>> tapestry.com.br is mine and can be used for that.
>>
>> --
>> Thiago H. de Paula Figueiredo
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: dev-help@tapestry.apache.org
>>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Ulrich Stärk <ul...@spielviel.de>.
On 03.08.2012 03:06, Bob Harner wrote:
> I have assumed I would be spending a bunch of time on this in the
> second half of 2012 and am willing to get started now. But I was
> hoping Uli was already working on it and just needs some help :-)
>
> I believe Uli is talking about the approach described at
> http://www.dankulp.com/blog/2012/03/svnpubsub-for-confluence-sites/,
> which I agree is the obvious way for us to proceed, at least for a
> while. It allows us to keep our high-quality documentation intact with
> little disruption. Any other approach (converting to another content
> editing system, with a different markup language) will likely require
> thousands of manual content tweaks of the sort that was done when the
> docs were first moved *into* Confluence.
Exactly. I've been exploring this option and it seems quite straightforward and simple. No need to
touch much, if anything.
>
> As for the javadocs, I'm wondering why there is talk of moving them.
> What's wrong with the current process there?
Our uninformed guess was that a switch to svnpubsub would make it impossible to manage website
content other than through svn/git (speaking of which, does that even work after our switch to git?
;)). So the current process of simply copying it into the correct place on people would not work
anymore.
>
>>> I like that it will be possible to navigate to a page and click an edit button.
AIUI this just works for content managed by the CMS. With our approach we'd just use svnpubsub, not
the CMS, for the reasons stated above.
Uli
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Bob Harner <bo...@gmail.com>.
I have assumed I would be spending a bunch of time on this in the
second half of 2012 and am willing to get started now. But I was
hoping Uli was already working on it and just needs some help :-)
I believe Uli is talking about the approach described at
http://www.dankulp.com/blog/2012/03/svnpubsub-for-confluence-sites/,
which I agree is the obvious way for us to proceed, at least for a
while. It allows us to keep our high-quality documentation intact with
little disruption. Any other approach (converting to another content
editing system, with a different markup language) will likely require
thousands of manual content tweaks of the sort that was done when the
docs were first moved *into* Confluence.
As for the javadocs, I'm wondering why there is talk of moving them.
What's wrong with the current process there?
>> I like that it will be possible to navigate to a page and click an edit button.
On Thu, Aug 2, 2012 at 5:01 PM, Thiago H de Paula Figueiredo
<th...@gmail.com> wrote:
> On Thu, 02 Aug 2012 12:11:30 -0300, Howard Lewis Ship <hl...@gmail.com>
> wrote:
>
>> Maybe host the JavaDoc it off-apache? We could use my
>> howardlewisship.com site, or go register tapestrydocs.net or
>> something.
>
>
> tapestry.com.br is mine and can be used for that.
>
> --
> Thiago H. de Paula Figueiredo
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Thiago H de Paula Figueiredo <th...@gmail.com>.
On Thu, 02 Aug 2012 12:11:30 -0300, Howard Lewis Ship <hl...@gmail.com>
wrote:
> Maybe host the JavaDoc it off-apache? We could use my
> howardlewisship.com site, or go register tapestrydocs.net or
> something.
tapestry.com.br is mine and can be used for that.
--
Thiago H. de Paula Figueiredo
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Howard Lewis Ship <hl...@gmail.com>.
On Wed, Aug 1, 2012 at 4:29 PM, Ulrich Stärk <ul...@spielviel.de> wrote:
> I suggest doing a migration to svnpubsub first and switch to Markdown or whatever else we want to
> use for documentation generation later. It's the autoexport that's going away, not Confluence itself.
>
> Also, we won't need any Django knowledge. The CMS' architecture might be influenced by Django but
> you certainly don't need to know anything about it in order to work with the CMS.
>
> Automatically generated source code documentation might indeed be a problem. We should find out how
> other projects are doing this. I don't like the idea of checking it back into SVN as part of the
> build process.
Maybe host the JavaDoc it off-apache? We could use my
howardlewisship.com site, or go register tapestrydocs.net or
something.
>
> Uli
>
> On 01.08.2012 21:15, Howard Lewis Ship wrote:
>> I think it's time that we switch over from Confluence to the CMS
>>
>> http://www.apache.org/dev/cms.html
>>
>> Looks like the CMS is going to be SVN regardless
>>
>> I'm hoping someone can volunteer to spearhead this; if not, I'll look
>> into it in a week or so.
>>
>> The docs kind of presume a lot of knowledge of some version of Django,
>> which I certainly don't have.
>>
>> I think markdown will be a fine format. I like that it will be
>> possible to navigate to a page and click an edit button. It should be
>> possible to open up our site repo to any Apache committer.
>>
>> I'm not quite sure what we'll do about published JavaDocs (and,
>> potentially, other reports, such as JavaScript/CoffeeScript docs).
>> Possibly, we'll need to generate those into an SVN folder and check
>> them into SVN for publishing to the site.
>>
>> I'm hoping the result will be something faster and easier to maintain,
>> and more customizable as well.
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
--
Howard M. Lewis Ship
Creator of Apache Tapestry
The source for Tapestry training, mentoring and support. Contact me to
learn how I can get you up and productive in Tapestry fast!
(971) 678-5210
http://howardlewisship.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: Time to switch from Confluence to CMS
Posted by Ulrich Stärk <ul...@spielviel.de>.
I suggest doing a migration to svnpubsub first and switch to Markdown or whatever else we want to
use for documentation generation later. It's the autoexport that's going away, not Confluence itself.
Also, we won't need any Django knowledge. The CMS' architecture might be influenced by Django but
you certainly don't need to know anything about it in order to work with the CMS.
Automatically generated source code documentation might indeed be a problem. We should find out how
other projects are doing this. I don't like the idea of checking it back into SVN as part of the
build process.
Uli
On 01.08.2012 21:15, Howard Lewis Ship wrote:
> I think it's time that we switch over from Confluence to the CMS
>
> http://www.apache.org/dev/cms.html
>
> Looks like the CMS is going to be SVN regardless
>
> I'm hoping someone can volunteer to spearhead this; if not, I'll look
> into it in a week or so.
>
> The docs kind of presume a lot of knowledge of some version of Django,
> which I certainly don't have.
>
> I think markdown will be a fine format. I like that it will be
> possible to navigate to a page and click an edit button. It should be
> possible to open up our site repo to any Apache committer.
>
> I'm not quite sure what we'll do about published JavaDocs (and,
> potentially, other reports, such as JavaScript/CoffeeScript docs).
> Possibly, we'll need to generate those into an SVN folder and check
> them into SVN for publishing to the site.
>
> I'm hoping the result will be something faster and easier to maintain,
> and more customizable as well.
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org