I believe that if users are more comfortable with using the wiki, they
should definitely do the documentation there - and as soon as we think
the time is ripe, we can take documentation over to the main page.

If you request of users to check out the source-head, install svn for
that, get forrest, get to know how forrest works and finally how to
create a patch, we will never get help with documentation, I would say
;)

So, as for me, please keep on documenting!

regards,

Martin

On 5/31/05, Sean Schofield <[EMAIL PROTECTED]> wrote:
> Yes that would make a good wiki actually (as long as its geared
> towards building the myfaces website)
> 
> sean
> 
> On 5/31/05, Werner Punz <[EMAIL PROTECTED]> wrote:
> > Wouldnt that be a good info on the wiki :-)...
> > btw... what is this Forrest thing?
> >
> > Werner
> >
> >
> > Sean Schofield wrote:
> >
> > > First off, its good to see users helping users on the wiki.  I have a
> > > suggestion when it comes to component documentation, however, which is
> > > that we update the documentation on the website.
> > >
> > > We are in desperate need of help in that department.  Here is how you
> > > can help.  Checkout the latest source code from subversion.  Update
> > > the xdocs used to build the website (they are located in
> > > source/documentation/content/xdocs/components.)   Use the
> > > component-template.xml as a basis for the new documentation.  Note
> > > there are already place holder pages for the components but the
> > > template has changed slightly so make sure it conforms to
> > > component-template.xml when you modify it.
> > >
> > > Important: run the pages through Apache Forrest and proofread them.
> > > Most likely you will get some complaints from forrest about your XML
> > > until you get the hang of things.  You just need to download
> > > ApacheForrest, set up FORREST_HOME in your path and type 'forrest' in
> > > the build dir.
> > >
> > > Once everything looks good generate a svn-patch.  Please create the
> > > patch from the top level of the project.  Also, please make sure the
> > > patch does not contain your other local changes unrelated to the
> > > documentation.  Submit the patch and any brand new files (most likely
> > > images for the screenshots) to the dev list and a committer will apply
> > > them.
> > >
> > > Screenshots are needed for almost all of the components.  Try to use
> > > one from the simple examples to make it consistent with what the user
> > > will see if they download the simple examples.
> > >
> > > sean
> > >
> >
> >
>

Reply via email to