On 10 November 2010 14:43, Guillaume Nodet <gno...@gmail.com> wrote:
> On Wed, Nov 10, 2010 at 14:40, Hadrian Zbarcea <hzbar...@gmail.com> wrote:
>> Thanks James,
>>
>> You have to comment out the dependency on scalate-test in the pom for this 
>> to work (otherwise you get a "Failed to resolve artifact").
>>
>> That aside, one of the important requirements I believe is not to raise the 
>> barrier to entry for those who want to contribute documentation. Today, one 
>> only needs to have a icla signed at apache and edit the wiki in place.
>
> This can be done by submitting a patch attached to Jira.
>
>> How is this solved? We talked about being able to edit in place and a patch 
>> being generated and added to a jira at apache. I don't see any support for 
>> that. Is that still the plan?
>
> I agree that would be a good idea.   I suppose redirecting to a live
> webapp hosted on some zone at the ASF would work.   We just need to
> actually write that web app ;-)

Its pretty easy to have a static website have an 'edit this page' type
link on the static HTML which just populates a <textarea> using jQuery
so users can edit the wiki content of the page. I've done this on a
few FuseForge sites in the past.

The tricky bit is having the web app to accept the POST which should
then take the new changed page and submit a JIRA or something. I'm
hoping GitHub will add something like this to their git-based-wiki
stuff they are doing; they've already got the awesome code review
stuff & pull request queue (so its easy for commiters to review a
patch and just apply it with one click).

Be that as it may; having an 'edit this page' link on the static HTML
site is a nice to have. Its very easy for folks to check out the
project from our svn and build the site themselves and edit the docs
then either send us a patch or fork on github and send us a link to
the commit so we can pull it etc.

-- 
James
-------
FuseSource
Email: ja...@fusesource.com
Web: http://fusesource.com
Twitter: jstrachan
Blog: http://macstrac.blogspot.com/

Open Source Integration

Reply via email to