yes toby we hear you, ole is saying the same, as well as others, namely that
egroups is flaky.
one thing at a time, but moving is certainly something we would look at in
the near future.
I was thinking of CVS first, then lists as needed. Is there a way on
egroups to make the archives readable by *everyone* particularly I think
restricting access to the docs lists makes no sense whatsoever (tobias ?:)
marc
|-----Original Message-----
|From: [EMAIL PROTECTED]
|[mailto:[EMAIL PROTECTED]]On Behalf Of Toby Allsopp
|Sent: Monday, January 22, 2001 10:27 AM
|To: jBoss
|Subject: Re: [jBoss-User] FW: [jboss-docs] next step - the tasks
|
|
|Are all of the lists going to move to this new big box you've been
|setting up? If not, I'd like to suggest at least moving them off egroups
|and on to somewhere that doesn't require you to give out your life story
|before you can even read the archives.
|
|Regards,
|Toby.
|
|marc fleury wrote:
|>
|> Guys, those of you that want to give us a helping hand please get on
|> jboss-docs, the list is coming alive and task are being
|assigned. Please go
|> register with them and help out if you can. Contact tobias on
|how to get on
|> the projects
|>
|> thanks
|>
|> marc
|>
|> |-----Original Message-----
|> |From: Tobias Frech [mailto:[EMAIL PROTECTED]]
|> |Sent: Sunday, January 21, 2001 12:17 AM
|> |To: [EMAIL PROTECTED]
|> |Subject: [jboss-docs] next step - the tasks
|> |
|> |
|> |PreS (Pre Scriptum): Sorry for the long silence from me. First I helped
|> |Marc to move the jboss.org site to a new location and now my company
|> |*tried* (!) to switch the provider and I am sitting here stranded like
|> |Robinson without net access. Hope this email gets through somehow.)
|> |
|> |Hi documentation community!
|> |
|> |First I wanted to inform you that our docu list has grown to respectable
|> |25 persons. If everyone on this list just completes a small task we
|> |should get a big leap ahead. Now let's get back to our plan:
|> |
|> |1) discuss and decide which docu types should survive
|> | status: mainly discussed and documented
|> |2) discuss and decide which format will be used:
|> | status: DocBook seems to be THE choice to go with.
|> | We have a very good start with tools and style sheets
|> |3) prioritize tasks and decide if any very important docu is missing
|> | status: *now active*
|> |4) assign docu writing, integrating and converting tasks.
|> |5) do it!
|> |6) See JBoss surpass Weblogic on the next review, as the docu should no
|> | longer be a problem ;-)
|> |
|> |As you can see at the status I wrote for 2) I think we are prepared to
|> |move ahead to the next step now. I tried the jbossdocs2.zip package and
|> |must say I am pretty impressed with the tools. Try it out yourself if
|> |you didn't up to now. Following minor issues are still there in my
|> |opinion:
|> |
|> |a) easier directory structure for package
|> |I would be very nice if we could simplify the dir structure. Right now
|> |we have: docu sources are in jbossdocs/src/docs, build scripts are in
|> |jbossdocs/build, result can be found in jbossdocs/dist/docs, needed libs
|> |are scattered through the whole package. What I'd like to have is to
|> |have the sources and the build scripts in the same directory. Also they
|> |should be located in the first or second subdir and _not_ in the third
|> |like now. I did not change the structure myself because I do not know
|> |how this whole thing has to fit into the existing dir structure of some
|> |developers. _Rickard_, if you understand what I mean and agree, perhaps
|> |you could make the arrangements ?
|> |
|> |b) Numbering in printed (PDF) docu.
|> |This is definitly needed, as well as a table of contents. Who knows how
|> |to do that with fop ?
|> |
|> |c) corrected <literallayout> style (left margin!)
|> |The left margin looks weird for this environment in PDF format. Can
|> |someone fix this ?
|> |
|> |d) smaller font for code
|> |A smaller font for the code parts (<literallayout> environment) would
|> |allow more letters per line in the printed docu. Who knows where and how
|> |to adjust that ?
|> |
|> |Guidelines
|> |----------
|> |While looking through the documents I felt that we need some sort of
|> |documentation guidelines which _help_ docu writers to avoid mistakes.
|> |Here are my initial suggestions:
|> |
|> |- Generally try to describe in detail. But if you have to repeat
|> |previously said content summarize it and refer to the section which
|> |describes the content in detail.
|> |- No more than 55 letters per line for <literallayout> environment,
|> |otherwise the PDF document will be messed up!
|> |- Target for readability: one or two heading(s) per page in the PDF
|> |format.
|> |
|> |I am sure you have some comments and something to add :-).
|> |
|> |Tasks
|> |-----
|> |What are the most important next steps now ? I am not 100% sure, so I
|> |will think loud here a little bit:
|> |We have the manual from Aaron. Some parts of it are not yet completed.
|> |Several people should take care of these parts together with Aaron.
|> |Vladimir transfered already some documentation to DocBook. A very good
|> |start for our docbook work. But we should also check that the contents
|> |of this document are the same as the actual website contents. Some
|> |doucments changed in the last weeks. CVS diffs come in handy here. We
|> |need to know two things about each section in this document: 1) Which
|> |part of the docu form the website is already included and 2) are the
|> |included parts "up-to-date" ?
|> |Both, manual and docbook, need to be restructured to the new structure
|> |we agreed on. For this the structure should be detailed enough to show
|> |for everybody which part goes to which part of the end result. Also the
|> |new inputs should be included in this structure. We already have this
|> |rough schema:
|> |
|> |1. User's Summary
|> |
|> |2. Quick Start
|> |
|> |3. Tutorial
|> |
|> |4. Manual :
|> |+ Installation
|> |
|> |+ Configuartion
|> |++ Basic (you should be ready to start the server afterwards)
|> |++ Advanced (extending the predefined datasources, Security, Logging
|> |etc.)
|> |
|> |+ Managing JBoss
|> |++ start/stop
|> |++ webinterface/jmx
|> |
|> |+ Writing software for JBoss
|> |++ beans
|> |+++ EJX
|> |+++ deploying
|> |++ clients
|> |
|> |+ Third-Party Products
|> |++ j2ee
|> |+++ tomcat
|> |+++ jetty
|> |++ persistence
|> |+++ cocobase
|> |+++ ozone
|> |+++ castor
|> |++ IDE
|> |+++ kawa
|> |+++ Jbuilder
|> |+++ VisualAge etc.
|> |
|> |+ J2EE topics
|> |++ JSP
|> |++ EJB 1.1
|> |++ JMX
|> |++ JMS
|> |
|> |5. FAQ
|> |
|> |6. Roadmap
|> |
|> |7. Miscellaneous - contains contact information, URLs etc
|> |
|> |
|> |Phew, lots of stuff. So let's do that step by step.
|> |
|> |Vladimir: We need your actual DocBook document. Can you put it online at
|> |egroups file section, please ?
|> |
|> |I) We need people that fix the issues mentioned before at a) - d)
|> |concerning the PDF output.
|> |II) In parallel to I): Let's make the structure/TOC detailed enough.
|> |III) After II) I will then set up a database at egroups, where everybody
|> |can pick a part and prepare it for the new final document.
|> |
|> |OK guys, let's get going with I) and II). Insert some more details into
|> |the structure I gave above and mail them around (don't forget the
|> |contributions we just got mailed to this list). I will myself make some
|> |suggestions for this in the next days.
|> |
|> |
|> |Am I missing something ?
|> |
|> |Cheers,
|> |Tobias
|> |
|> |-----------------------------------------------------------
|> |To unsubscribe email to: [EMAIL PROTECTED]
|> |
|> |
|> |
|>
|> --
|> --------------------------------------------------------------
|> To subscribe: [EMAIL PROTECTED]
|> To unsubscribe: [EMAIL PROTECTED]
|> List Help?: [EMAIL PROTECTED]
|
|--
|Toby Allsopp
|Energy Research Lab
|Peace Software International Ltd
|Ph +64-9-3730400
|
|
|--
|--------------------------------------------------------------
|To subscribe: [EMAIL PROTECTED]
|To unsubscribe: [EMAIL PROTECTED]
|List Help?: [EMAIL PROTECTED]
|
--
--------------------------------------------------------------
To subscribe: [EMAIL PROTECTED]
To unsubscribe: [EMAIL PROTECTED]
List Help?: [EMAIL PROTECTED]
