Only 48 hours left in the trailboss' kickstarter!

New rewards and stretch goals. CLICK HERE!



  • Post Reply Bookmark Topic Watch Topic
  • New Topic

war file standards for src and documentation  RSS feed

 
Bernie O'Neill
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Is there a standard used for grouping extra information like source code and integration documentation in a war file?
In particular, if I have source code and documentation (ex. How to, What it does, Test procedure) for a re-useable JSR 168 Portlet, should it be bundled under WEB-INF/src and WEB-INF/docs or is there another standard approach?

Thanks for any guidance you can provide.
 
Jeanne Boyarsky
author & internet detective
Sheriff
Posts: 36393
453
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
"oneilbj",
We're pleased to have you here with us in the EJB forum, but there are a few rules that need to be followed, and one is that proper names are required. Please take a look at the JavaRanch Naming Policy and adjust your display name to match it.

In particular, your display name must be a first and a last name separated by a space character. Please add a last name.

Thanks,
Jeanne
Forum Bartender
 
Bernie O'Neill
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks for the feedback. My apologies. I have corrected my Display Name now.

It would seem to make sense to bundle Portlet source code and documentation (like "How this works", "Portal integration notes", "Dependencies", "test procedures") within the war file for simplicity of delivery and install. I would think that they should be under WEB-INF which is protected from web access.
Is WEB-INF/src a good place to put source code?
Is WEB-INF/docs a good place to put general documents
Is WEB-INF/docs/api a good place for Javadocs?

Thanks for any guidance.
 
Jeanne Boyarsky
author & internet detective
Sheriff
Posts: 36393
453
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Bernie,
Thanks for fixing the display name!

Personally, I would put the source and documentation into a separate jar. Why make someone deploy more than necessary? If you want it in the same jar, your approach seems ok.
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!