Where should should project documentation (requirements, etc.) be stored in a typical maven project.
None of the directories listed in Introduction to the Standard Directory Layout page is an obvious candidate.
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
Unfortunately there is no convention. If you want the documentation to be part of the generated site, obviously
/src/siteis a good place. Maybe you can even write the documentation in the APT format?But more likely you have a set of
doc,pdfandxlsfiles, graphics, e-mails, etc. You can either place them under/src/siteas well and put hyperlinks in the site or… define your own convention, sadly. Typically I have seen/src/main/doc(s),/src/doc(s)or even/doc(s).You don’t want to place your documentation in
/src/main/resourcesorsrc/main/webapp, as the files will then be part of built artifact (JAR/WAR) which is rarely desired.