camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Daniel Kulp <dk...@apache.org>
Subject Re: helping out with the Web site
Date Wed, 10 Nov 2010 14:51:27 GMT
On Wednesday 10 November 2010 9:43:13 am Guillaume Nodet wrote:
> On Wed, Nov 10, 2010 at 14:40, Hadrian Zbarcea <hzbarcea@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.

Which is still a fairly high barrier.    For CXF, we recently got a volunteer 
that has been doing a WONDERFUL job cleaning up various pages on the website.   
That individual has dived right in and started working on thing.   He's also 
logged some JIRA issues about updating javadoc and warnings and such, but I'm 
having problems working with him to get patches created.   For some people, 
working with something like svn or git or even maven is a challenge.   It is 
more stuff to install (everyone has a browser installed) and learn.  

For most of the people on this list, it ISN'T a big deal.   We deal with svn 
and mvn every day.   For others, it could be.
 
> > 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 ;-)

Now THAT is an interesting idea.   :-)

Dan



> 
> > Cheers,
> > Hadrian
> > 
> > On Nov 10, 2010, at 5:50 AM, James Strachan wrote:
> >> FWIW I started an experimental spike to try recreate the Camel website
> >> using wiki files from source control - exported from Confluence -
> >> (rather than the Confluence / AutoExport icky stuff) like Karaf &
> >> ServiceMix are doing. More as a test of Scalate than any attempt to
> >> actually change any documentation. (I didn't actually touch any of the
> >> Camel documentation at all; just tweaked the layout/Scalate stuff to
> >> get it just about working)...
> >> 
> >> https://github.com/jstrachan/camel-docs
> >> 
> >> Looks like we've one or two fairly trivial confluence macros to
> >> implement & a couple of wikitext bugs to have a faithful reproduction
> >> of the site, but its not a bad start.
> >> 
> >> e.g.  do this...
> >> 
> >> git clone https://github.com/jstrachan/camel-docs.git
> >> cd camel-docs
> >> mvn jetty:run
> >> 
> >> then see these pages which don't quite work :(...
> >> 
> >> http://localhost:8080/documentation/enterprise-integration-patterns.html
> >> http://localhost:8080/documentation/components.html
> >> 
> >> On 9 November 2010 19:44, Eric Johnson <emjohnson@fusesource.com> wrote:
> >>> I'm a committer on CXF and have been helping out with the ServiceMix
> >>> site redesign. I'm interested in helping Camel maintain its Web site
> >>> as well. Are there any tasks that need tackling that I can get started
> >>> on?
> >>> 
> >>> --
> >>> Principle Technical Writer
> >>> Phone (781) 280-4174
> >>> Skype finnmccumial
> >>> E-Mail emjohnson@fusesource.com
> >>> Blog http://documentingit.blogspot.com/
> >> 
> >> --
> >> James
> >> -------
> >> FuseSource
> >> Email: james@fusesource.com
> >> Web: http://fusesource.com
> >> Twitter: jstrachan
> >> Blog: http://macstrac.blogspot.com/
> >> 
> >> Open Source Integration

-- 
Daniel Kulp
dkulp@apache.org
http://dankulp.com/blog

Mime
View raw message