Hi Lincoln, folks,
I'd just like to outline what I would expect as Forge documentation.
I think we need two kinds of guides (think of a 'guide' in the broadest
possible sense). We need users and developers guide.
In the users guide I would look for two things: guide for the most popular
plugins (something like this:
https://docs.jboss.org/author/display/FORGE/Arquillian+Testing). And then
we need a walkthrough for the common usecases (Java EE application with
JSF, OSGi application, Forge plugin, etc.). Something like this:
https://docs.jboss.org/author/display/FORGE/Generating+a+basic+Java+EE+we...
.
Of course video sessions are even better :-)
The next part is the dev guides. We have some great pages in our wiki (the
children of
https://docs.jboss.org/author/display/FORGE/Developing+a+Plugin),
but some pictures would be very helpful. What I mean is something that
would present the structure of the APIs: for what do you use the shell, the
environment, the configuration, the different facets and all the other
important objects in the tool core. I say again, the above page and its
children are great, but a "big picture" would make them even better.
Having said that, I can for sure contribute with manuals and guides.
However, I'm not a native speaker, so I would need a review of what I
wrote...
Cheers,
Ivan
On Wed, Jan 25, 2012 at 5:38 PM, Lincoln Baxter, III <
lincolnbaxter(a)gmail.com> wrote:
Hi everyone :)
We're coming up on the CR1 release of Forge, and we'd like to get some of
the documentation updated so that using Forge and writing Forge plugins is
easier than ever! This means that we need help creating some new pages in
the Forge Documentation <
https://docs.jboss.org/author/display/FORGE>
If you could spend a little time:
- Identifying what information is missing
- Creating or editing pages to bring this information up to date
Just email the list with what you think needs to be included or updated,
and we'll figure out the best place for you to put it!
Thank you for your help!
--
Lincoln Baxter, III
http://ocpsoft.com
http://scrumshark.com
"Keep it Simple"
_______________________________________________
forge-dev mailing list
forge-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/forge-dev