Documentation

Apr 10, 2009 at 5:26 PM
Hello,

I'm having some trouble getting NPanday to work. I'm certain I could figure it out, but I can not find the usually plugin documentation that is usually available for maven plugins.  I have looked at the source and looked through the various test pom's I could find, but it would be a whole lot easier if the normal documentations was available.  Can anyone point me to where to look?

Thanks!

-Jim
Coordinator
Apr 13, 2009 at 10:26 AM
Hi,

You can check out the source code at https://npanday.svn.codeplex.com/svn/trunk

and then the documentation is located in the site\src\site\apt

There are also links in the home page of npanday.

http://npanday.codeplex.com/Wiki/View.aspx?title=NPanday%20Wiki

http://npanday.codeplex.com/Wiki/View.aspx?title=Building%20NPanday

We hope that helps you in using npanday.

Thanks,
Apr 13, 2009 at 2:54 PM
Hello,

Thanks for the response.  I have mined the wiki quite a bit but have been unable to find the documentation of how the plugins work.  I pulled what you suggested out of SVN, but it does not have the documenation I am referring too.  As you suggest, it's just the wiki in a different format.

What I am really looking for is the detailed plugin documentation.  For example, the Maven Deploy plugin has documentation like at this link:

http://maven.apache.org/plugins/maven-deploy-plugin/

That link has at least moderatly detailed information about what paramaters are valid for the plugin and how they are used.  Does anything like that exist?

Thanks!

-Jim
Coordinator
Apr 14, 2009 at 4:27 AM
Unfortunately there are no documentation specific to each plugins that npanday has at the moment. We will create an issue for that, thanks for pointing it out.
Developer
Apr 14, 2009 at 4:33 AM
On Mon, Apr 13, 2009 at 8:27 PM, [email removed] wrote:

> Unfortunately there are no documentation specific to each plugins that
> npanday has at the moment. We will create an issue for that, thanks for
> pointing it out.

I think the OP is looking for the Maven-generated site for the
plugins. It should be possible to publish that -- the pom has a
distributionManagement section, so it looks like someone tried at one
point. (mvn site-deploy, or just 'mvn site' and upload the results
somewhere.)

--
Wendy
Apr 15, 2009 at 8:31 PM
Hi there,

I gave Wendy's suggestion a try, but I have not really had much luck building NPanday.  I got this error message:

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] \\META-INF\plexus\components.xml (The network path was not found)

Anyway, Wendy is correct, I think, in what I am looking for.

-Jim
Developer
Dec 18, 2009 at 8:04 PM

Are there any plans to publish the plugin docs on an 'official' website?

For example, at Maven, there's a /plugins subdirectory where the docs for the latest release of each plugin can be found.  Since NPanday releases and versions everything together, it would seem to make sense to publish them under /docs/npanday-X.Y/plugins .

As far as I can tell, there's no way to publish the generated html docs on Codeplex.  Is there somewhere else it can live?

Thanks, -Wendy

Coordinator
Dec 20, 2009 at 2:18 AM
http://www.npanday.org/docs/1.1-SNAPSHOT is up, but the plugin docs haven't been published as far as I can tell. That'd be the right place to start publishing docs from the 1.1 release onwards.

- Brett

On 19/12/2009, at 7:04 AM, wsmoak wrote:

From: wsmoak

Are there any plans to publish the plugin docs on an 'official' website?

For example, at Maven, there's a /plugins subdirectory where the docs for the latest release of each plugin can be found. Since NPanday releases and versions everything together, it would seem to make sense to publish them under /docs/npanday-X.Y/plugins .

As far as I can tell, there's no way to publish the generated html docs on Codeplex. Is there somewhere else it can live?

Thanks, -Wendy

Read the full discussion online.

To add a post to this discussion, reply to this email (npanday@discussions.codeplex.com)

To start a new discussion for this project, email npanday@discussions.codeplex.com

You are receiving this email because you subscribed to this discussion on CodePlex. You can unsubscribe or change your settings on codePlex.com.

Please note: Images and attachments will be removed from emails. Any posts to this discussion will also be available online at codeplex.com



Developer
Dec 23, 2009 at 10:28 PM
Edited Dec 23, 2009 at 10:32 PM
brettporter wrote:
http://www.npanday.org/docs/1.1-SNAPSHOT is up, but the plugin docs haven't been published as far as I can tell. That'd be the right place to start publishing docs from the 1.1 release onwards.

 

Okay, thanks.  Until that happens, I've published all the plugin docs from trunk here:  http://wsmoak.net/npanday/plugins/

 

Some of them have docs written by the developers, others just have the generated pages.  

 

At a minimum, under each plugin you can click 'Project Reports' in the left hand menu and then 'Plugin Documentation'  which will give you a page that lists the plugin goals and further links to a page for each goal that describes the parameters.

 

-- 
Wendy