[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-643) Document Maven Tools functionality in User Guide

Misha Ali (JIRA) issues at jboss.org
Tue May 12 23:54:19 EDT 2015


    [ https://issues.jboss.org/browse/TOOLSDOC-643?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13067496#comment-13067496 ] 

Misha Ali commented on TOOLSDOC-643:
------------------------------------

Scoping for 9.0 (and 8.1, for the time being).

Tentative plan based on existing information and requirements outlined by Burr earlier:

1. Introduction
  - A brief intro exists in the introduction section of the maven tools ref guide (JBDS 7.1).
2. Install Maven in JBDS
3. Using maven (Basic)
  a. Create a new maven project - instructions for 7.1 in maven tools ref guide
  b. Create a maven module (pre-req is maven project) - instructions for 7.1 in maven tools ref guide 
  c. Add maven support to an existing project - instructions for 7.1 in maven tools ref guide
4. Using Maven (Advanced) - wishlist of more advanced topics to cover after basics are done and published
  - how to enable autdownload of source and javadoc
  - usage of maven source lookup container (it somewhat automates the automatic download)
  - explain maven lifecycles and how it can result in warnings/errors you as user don't really care or want to care about
  - in here explain how jboss tools and eclipse provides some autoconfiguration based on what plugins are used
  - document the maven properties you can use to turn on/off this auto config such as enable hibernate, annotation processors, war projects etc.

For the current scope, I'll create an article addressing the basics of using Maven with JBDS (i.e. points 1-3 from the tentative plan above), test it and get it approved by QE and publish it for the 8.1 docs, then test for 9.0 later and make changes if required.

> Document Maven Tools functionality in User Guide
> ------------------------------------------------
>
>                 Key: TOOLSDOC-643
>                 URL: https://issues.jboss.org/browse/TOOLSDOC-643
>             Project: Documentation for JBoss Tools and Developer Studio
>          Issue Type: Feature Request
>          Components: General documentation issues
>            Reporter: Michelle Murray
>            Assignee: Misha Ali
>              Labels: JBDS80_Approved_Scope
>             Fix For: 4.3.0.Final
>
>
> Add a chapter to the JBDS User Guide on Maven Tools.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)


More information about the jbosstools-issues mailing list