You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Farrukh Najmi <fa...@wellfleetsoftware.com> on 2008/08/15 17:21:46 UTC
Where to place design documents
Is there a standard place in the maven project structure for placing
design documents for a project?
I could imagine the following possibilities but was wondering if there
was an existing convention in the making:
* <root>/src/design
* <root>/design
* <root>/test/design
Thanks for your input.
--
Regards,
Farrukh Najmi
Web: http://www.wellfleetsoftware.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Where to place design documents
Posted by Geoffrey Wiseman <ge...@gmail.com>.
On Fri, Aug 15, 2008 at 11:21 AM, Farrukh Najmi <
farrukh@wellfleetsoftware.com> wrote:
> Is there a standard place in the maven project structure for placing design
> documents for a project?
> I could imagine the following possibilities but was wondering if there was
> an existing convention in the making:
I suspect that there are very few conventions for things Maven doesn't care
about -- unless you're planning on pushing these into the Maven site or
something of that ilk, otherwise making them a part of your build, then I
imagine you'll find that varies significantly. My own answer to that would
be "in the wiki?".
- Geoffrey
--
Geoffrey Wiseman
Re: Where to place design documents
Posted by Kathryn Huxtable <ka...@kathrynhuxtable.org>.
I'm with Wendy on this. Put them in src/site/resources unless you'd
rather put them in some external documentation such as a wiki.
-K
On Aug 15, 2008, at 10:30 AM, Wendy Smoak wrote:
> On Fri, Aug 15, 2008 at 8:21 AM, Farrukh Najmi
> <fa...@wellfleetsoftware.com> wrote:
>> Is there a standard place in the maven project structure for
>> placing design
>> documents for a project?
>
> If you want them to be published as part of the project website,
> putting them under src/site/resources would work.
>
> It depends on how you want people to consume them-- from their scm
> checkout, or as published docs.
>
> --
> Wendy
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Where to place design documents
Posted by Wendy Smoak <ws...@gmail.com>.
On Fri, Aug 15, 2008 at 8:21 AM, Farrukh Najmi
<fa...@wellfleetsoftware.com> wrote:
> Is there a standard place in the maven project structure for placing design
> documents for a project?
If you want them to be published as part of the project website,
putting them under src/site/resources would work.
It depends on how you want people to consume them-- from their scm
checkout, or as published docs.
--
Wendy
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: RE Where to place design documents
Posted by "Siegmann Daniel, NY" <Da...@fja-us.com>.
I see nothing in that document which answers the question. I too have
wondered this, but settled for just putting a docs folder on the root
level (since we do not use site in most of our projects).
It would be nice to have a standard folder for this, even if Maven
doesn't use it (now), though src/main/docs seems better. Though Maven
doesn't use this (for now), one of the advantages of having a project
set up in Maven is that I know where to look for things even if I'm
unfamiliar with the project.
I have thought about trying to get automatic documentation generation in
our builds by using something like LaTeX or Docbook XML. I have seen a
little bit from people who have done this, though it doesn't seem
common. But I haven't investigated deeply due to a lack of both time and
interest from my coworkers.
--
Daniel Siegmann
FJA-US, Inc.
512 Seventh Ave., New York, NY 10018
(212) 840-2618 ext. 139
-----Original Message-----
From: David Bernard [mailto:David.Bernard@ingcanada.com]
Sent: Friday, August 15, 2008 11:42 AM
To: Maven Users List
Subject: RE Where to place design documents
Hi,
take a look at this link:
http://maven.apache.org/guides/introduction/introduction-to-the-standard
-directory-layout.html
You will problably find the answer
David Bernard
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE Where to place design documents
Posted by David Bernard <Da...@ingcanada.com>.
Hi,
take a look at this link:
http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html
You will problably find the answer
David Bernard
Farrukh Najmi
<farrukh@wellflee
tsoftware.com> A
users@maven.apache.org
2008-08-15 11:23 cc
Objet
Veuillez répondre Where to place design documents
à
"Maven Users
List"
<users@maven.apac
he.org>
Is there a standard place in the maven project structure for placing
design documents for a project?
I could imagine the following possibilities but was wondering if there
was an existing convention in the making:
* <root>/src/design
* <root>/design
* <root>/test/design
Thanks for your input.
--
Regards,
Farrukh Najmi
Web: http://www.wellfleetsoftware.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org