-
1. Re: version 2 documentation
alesj Oct 15, 2007 12:16 PM (in response to jhalliday)"jhalliday" wrote:
Please could you let me know if the example and getting started guide are sufficiently up to date to be useful (or at least not misleading) and if so, what is the mvn command to generate them from the docbook source in svn?
The up-to-date examples and user-guide are currently only present in svn repo.
You can easily build the user-guide from svn trunk. Simply go to docs dir and run 'mvn generate-source'.
More detailed info how to run examples follows (along with fancy UI :-)).
But it should all be there in 2weeks - having a meeting in between, just for this purpose ;-). -
2. Re: version 2 documentation
galder.zamarreno Oct 16, 2007 6:21 PM (in response to jhalliday)Thanks Ales :)
-
3. Re: version 2 documentation
newtonm Oct 19, 2007 10:24 AM (in response to jhalliday)I've started work on a new Getting Started Guide which you can find in SVN here:
http://anonsvn.jboss.org/repos/jbossas/projects/microcontainer/trunk/docs/Getting_Started_Guide/
It's only a couple of pages at the moment as I have still to check in my examples and additional content.
To build it you need to enter the following command from within the same directory:
mvn install
You also need to have you ~/.m2/settings.xml file setup according to this wiki page:
http://wiki.jboss.org/wiki/Wiki.jsp?page=MavenSettings -
4. Re: version 2 documentation
trustin Oct 24, 2007 12:17 PM (in response to jhalliday)I ran 'mvn install' and got the following result:
http://rafb.net/p/3pKKWq17.html
The resulting microcontainer-getting-started-guide-en-US-1.0-SNAPSHOT-pdf.war contains a PDF file with 13 pages that most sections are missing. Am I missing something, or is it just because the documentation is in progress? -
5. Re: version 2 documentation
alesj Oct 24, 2007 12:26 PM (in response to jhalliday)"trustin" wrote:
The resulting microcontainer-getting-started-guide-en-US-1.0-SNAPSHOT-pdf.war contains a PDF file with 13 pages that most sections are missing. Am I missing something, or is it just because the documentation is in progress?
This is what Mark just pushed in - and it looks like there is no content. :-)
You should look at '(your_root_here)\microcontainer\docs\gettingstarted\en-US\target\docbook\html'.
This is where somehow readable version of docs resides. -
6. Re: version 2 documentation
trustin Nov 7, 2007 12:12 PM (in response to jhalliday)Doh! I didn't know that the repository URL for the getting started guide has been changed (from camel notation to lower cases). Checking out and building from the following URL gave me a 96 pages PDF file. Thanks for the great work!
https://svn.jboss.org/repos/jbossas/projects/microcontainer/trunk/docs